Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update contribute.rst #78

Merged
merged 4 commits into from
Oct 6, 2020
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 58 additions & 6 deletions docs/source/contribute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,64 @@
Contribute
##########

Vircadia is an open-source project, so all of our code and documentation is available for you to look at. You too can contribute to our endeavor for the metaverse!
Vircadia is an open-source project, so all of our code and documentation is available for you to look at. You too can contribute to our endeavor for the metaverse!
Our main `GitHub repository <https://github.com/kasenvr/project-athena>`_ contains the source to many of the components of our software for creating virtual worlds.
JulianGro marked this conversation as resolved.
Show resolved Hide resolved
There are tons of ways you can contribute to the various parts that make up Vircadia.
JulianGro marked this conversation as resolved.
Show resolved Hide resolved

Our `GitHub repository <https://github.com/kasenvr/project-athena>`_ contains the source to many of the components of our software for creating virtual worlds. The project embraces distributed development. If you find a small bug and have a fix, pull requests are welcome.
.. contents:: On This Page
:depth: 2

-----------------
Developer Section
-----------------
-------------
Documentation
-------------
You can help create and maintain the documentation in several ways:

All information required to build from source and develop the project is found in the :doc:`Developer Section <developer>`.
- Report errors or missing information to the `Github issue tracker <https://github.com/kasenvr/vircadia-docs-sphinx/issues>`_.
JulianGro marked this conversation as resolved.
Show resolved Hide resolved
- Create or change documentation pages and open a `PR (pull request) on Github <https://github.com/kasenvr/vircadia-docs-sphinx/pulls>`_.
JulianGro marked this conversation as resolved.
Show resolved Hide resolved
- `Review changes <https://github.com/kasenvr/vircadia-docs-sphinx/pulls?q=is%3Apr+is%3Aopen+label%3A"needs+review">`_ to the documentation on Github. We would like to have two reviewers for most changes, as there are always things that the writer and the first reviewer overlook.


-----------
Translation
-----------
As an international project, Vircadia relies on translators to be able to reach users that do not speak English.
Currently the only component that has translation support is the documentation.
You can help translating using our online translation system `Weblate <https://weblate.vircadia.dev>`_ by either submitting translations or becoming a maintainer for your language and checking translations before they make it into the documentation.
More information on translating the documentation can be found in its `README <https://github.com/kasenvr/vircadia-docs-sphinx/blob/master/README.md>`_.

---------
Donations
---------
Most, if not all, of us work voluntarily without any payment.
JulianGro marked this conversation as resolved.
Show resolved Hide resolved
While we do not have an entity to manage donations, you can donate to specific members of the team via various services like PayPal, Patreon, or Github Sponsors.

You can also put bounties on specific features you want to see implemented or issues you want to see fixed, by leaving a comment on our `issue tracker <https://github.com/kasenvr/project-athena/issues>`_.
Of course, bounties are also an option for other parts of the project like the documentation.
The bounties are based on trust, so if you are unsure about something speak to a core developer or bring it up at a community or developer meeting.
JulianGro marked this conversation as resolved.
Show resolved Hide resolved
Most of the developers are highly trained and experienced, normally earning upwards of 40$ an hour on the free market. Keep that in mind if you want to see something done that no one else is personally interested in.
JulianGro marked this conversation as resolved.
Show resolved Hide resolved

-----------
Development
-----------
You can help the general development of the Vircadia project without being much a of a developer yourself by:
JulianGro marked this conversation as resolved.
Show resolved Hide resolved

- filing issues on our `issue tracker <https://github.com/kasenvr/project-athena/issues>`_,
- helping to narrow down those issues,
- or `testing pull requests <https://github.com/kasenvr/project-athena/pulls?q=is%3Apr+is%3Aopen+label%3A"needs+QA+(testing)">`_.

If you are a developer, you can contribute directly to the project via pull requests. Keep the `guidelines <https://github.com/kasenvr/project-athena/blob/master/CONTRIBUTING.md>`_ in mind when contributing to the main software.
Some additional information can be found in the :doc:`Developer Section <developer>`.
An important job for developers that have become more accustomed to the platform is `code reviews <https://github.com/kasenvr/project-athena/pulls?q=is%3Apr+is%3Aopen+label%3A"needs+CR+(code+review)">`_ of open pull requests.

------------------
Miscellaneous work
JulianGro marked this conversation as resolved.
Show resolved Hide resolved
------------------
There is also a lot of miscellaneous work that comes up every now and then:

- 2D art like posters or banners,
- 3D models,
- scripts,
- video editing,
- and so on.

It is tremendously helpful for a developers to have someone they can ask when they need work done outside of their area of experience.
JulianGro marked this conversation as resolved.
Show resolved Hide resolved