From 3cd2c0c1c7d3bb5c85a00d6a7e5bd646671b0b1e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julian=20Gro=C3=9F?= Date: Sat, 12 Sep 2020 06:30:37 +0200 Subject: [PATCH 1/4] Add information on how to contribute to the project --- docs/source/contribute.rst | 64 ++++++++++++++++++++++++++++++++++---- 1 file changed, 58 insertions(+), 6 deletions(-) diff --git a/docs/source/contribute.rst b/docs/source/contribute.rst index 29e00d04..230f9370 100644 --- a/docs/source/contribute.rst +++ b/docs/source/contribute.rst @@ -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 `_ contains the source to many of the components of our software for creating virtual worlds. +There is tons of ways you can contribute to the various parts that make the Vircadia project. -Our `GitHub repository `_ 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 creating and maintaining the documentation in several ways: -All information required to build from source and develop the project is found in the :doc:`Developer Section `. \ No newline at end of file +- Report errors or missing information to the `Github issue tracker `_. +- Create or change documentation pages and open a `PR (pull request) on Github `_. +- `Review changes `_ to the documentation on Github. Currently we would like to have two reviews for most changes, as there is always things that the writer and the first reviewer overlooked. + + +----------- +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 on our online translation system `Weblate `_ 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 `_. + +--------- +Donations +--------- +Most, if not all, of us work voluntarily without any payment. +While we do not have an entity to manage donations, you can donate to specific members of the team via various services like PayPal or Patreon. + +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 `_. +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. +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 is personally interested in. + +----------- +Development +----------- +You can help the general development of the Vircadia project without being much a of a developer yourself by: + +- filing issues on our `issue tracker `_, +- helping to narrow down those issues, +- or `testing pull requests `_. + +If you are a developer you can contribute directly to the project via pull request. Keep the `guidelines `_ in mind when contributing to the main software. +Some additional information can be found in the :doc:`Developer Section `. +An important job for developers that have become more accustomed to the platform is `code reviews `_ of open pull requests. + +------------------ +Miscellaneous work +------------------ +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 outside of their area of experience done. From 4fe36dc802fed4e04cae8861e02408425ed8be25 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julian=20Gro=C3=9F?= Date: Mon, 14 Sep 2020 05:26:17 +0200 Subject: [PATCH 2/4] Code review --- docs/source/contribute.rst | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/source/contribute.rst b/docs/source/contribute.rst index 230f9370..d3cf0e5f 100644 --- a/docs/source/contribute.rst +++ b/docs/source/contribute.rst @@ -4,7 +4,7 @@ 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! Our main `GitHub repository `_ contains the source to many of the components of our software for creating virtual worlds. -There is tons of ways you can contribute to the various parts that make the Vircadia project. +There are tons of ways you can contribute to the various parts that make up Vircadia. .. contents:: On This Page :depth: 2 @@ -12,42 +12,42 @@ There is tons of ways you can contribute to the various parts that make the Virc ------------- Documentation ------------- -You can help creating and maintaining the documentation in several ways: +You can help create and maintain the documentation in several ways: - Report errors or missing information to the `Github issue tracker `_. - Create or change documentation pages and open a `PR (pull request) on Github `_. -- `Review changes `_ to the documentation on Github. Currently we would like to have two reviews for most changes, as there is always things that the writer and the first reviewer overlooked. +- `Review changes `_ 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. +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 on our online translation system `Weblate `_ by either submitting translations or becoming a maintainer for your language and checking translations before they make it into the documentation. +You can help translating using our online translation system `Weblate `_ 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 `_. --------- Donations --------- Most, if not all, of us work voluntarily without any payment. -While we do not have an entity to manage donations, you can donate to specific members of the team via various services like PayPal or Patreon. +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 `_. -Of course bounties are also an option for other parts of the project like the documentation. +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 `_. +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. -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 is personally interested in. +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. ----------- Development ----------- You can help the general development of the Vircadia project without being much a of a developer yourself by: -- filing issues on our `issue tracker `_, +- filing issues on our `issue tracker `_, - helping to narrow down those issues, - or `testing pull requests `_. -If you are a developer you can contribute directly to the project via pull request. Keep the `guidelines `_ in mind when contributing to the main software. +If you are a developer, you can contribute directly to the project via pull requests. Keep the `guidelines `_ in mind when contributing to the main software. Some additional information can be found in the :doc:`Developer Section `. An important job for developers that have become more accustomed to the platform is `code reviews `_ of open pull requests. @@ -62,4 +62,4 @@ There is also a lot of miscellaneous work that comes up every now and then: - video editing, - and so on. -It is tremendously helpful for a developers to have someone they can ask when they need work outside of their area of experience done. +It is tremendously helpful for a developers to have someone they can ask when they need work done outside of their area of experience. From 592acbc9ea930d6d190e3d6a772191b852601a6b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julian=20Gro=C3=9F?= Date: Tue, 6 Oct 2020 19:39:13 +0200 Subject: [PATCH 3/4] Apply suggestions from code review Co-authored-by: kasenvr <52365539+kasenvr@users.noreply.github.com> --- docs/source/contribute.rst | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/source/contribute.rst b/docs/source/contribute.rst index d3cf0e5f..e0383207 100644 --- a/docs/source/contribute.rst +++ b/docs/source/contribute.rst @@ -3,8 +3,8 @@ 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! -Our main `GitHub repository `_ contains the source to many of the components of our software for creating virtual worlds. -There are tons of ways you can contribute to the various parts that make up Vircadia. +Our main `git repository `_ contains the source to many of the components of our software for creating virtual worlds. +There are plenty of ways you can contribute to the various parts that make up Vircadia. .. contents:: On This Page :depth: 2 @@ -14,8 +14,8 @@ Documentation ------------- You can help create and maintain the documentation in several ways: -- Report errors or missing information to the `Github issue tracker `_. -- Create or change documentation pages and open a `PR (pull request) on Github `_. +- Report errors or missing information to the `GitHub issue tracker `_. +- Create or change documentation pages and open a `PR (pull request) on GitHub `_. - `Review changes `_ 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. @@ -30,18 +30,18 @@ More information on translating the documentation can be found in its `README `_. 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. -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. +Bounties are created and assigned based on trust, so if you are unsure about something regarding one then speak to a core developer or bring it up at a community or developer meeting. +Most of the developers are highly trained and experienced, normally earning upwards of $40 an hour in the free market. Keep that in mind if you want to see something accomplished that no one else is personally interested in. ----------- Development ----------- -You can help the general development of the Vircadia project without being much a of a developer yourself by: +You can help the general development of the Vircadia project without being a developer yourself by: - filing issues on our `issue tracker `_, - helping to narrow down those issues, @@ -52,7 +52,7 @@ Some additional information can be found in the :doc:`Developer Section `_ of open pull requests. ------------------ -Miscellaneous work +Miscellaneous Work ------------------ There is also a lot of miscellaneous work that comes up every now and then: @@ -62,4 +62,4 @@ There is also a lot of miscellaneous work that comes up every now and then: - 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. +It is tremendously helpful for developers to have someone that they can ask for assistance when they need work done that is outside their area of expertise. From e7d36d3d26caa4173d3446da512301aff436032f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julian=20Gro=C3=9F?= Date: Wed, 7 Oct 2020 01:34:27 +0200 Subject: [PATCH 4/4] Apply suggestions from code review Co-authored-by: kasenvr <52365539+kasenvr@users.noreply.github.com> --- docs/source/contribute.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/contribute.rst b/docs/source/contribute.rst index e0383207..5807fdf1 100644 --- a/docs/source/contribute.rst +++ b/docs/source/contribute.rst @@ -36,7 +36,7 @@ While we do not have an entity to manage donations, you can donate to specific m 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 `_. Of course, bounties are also an option for other parts of the project like the documentation. Bounties are created and assigned based on trust, so if you are unsure about something regarding one then speak to a core developer or bring it up at a community or developer meeting. -Most of the developers are highly trained and experienced, normally earning upwards of $40 an hour in the free market. Keep that in mind if you want to see something accomplished that no one else is personally interested in. +Most of the developers are highly trained and experienced, normally earning upwards of US$40 an hour in the free market. Keep that in mind if you want to see something accomplished that no one else is personally interested in. ----------- Development