monorail
/
Archipelago
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Docs: Rework of Contributing.md (#2278) 

* Update contributing.md

* Update docs/contributing.md

Co-authored-by: black-sliver <59490463+black-sliver@users.noreply.github.com>

* Update contributing.md

Separated the sentence specifically for web stuff as well as slight rephrasing of the first bullet point

* Update docs/contributing.md

Co-authored-by: black-sliver <59490463+black-sliver@users.noreply.github.com>

* Update docs/contributing.md

Changed the order of two words

Co-authored-by: Scipio Wright <scipiowright@gmail.com>

* Update docs/contributing.md

Clarified "this document"

Co-authored-by: Scipio Wright <scipiowright@gmail.com>

---------

Co-authored-by: black-sliver <59490463+black-sliver@users.noreply.github.com>
Co-authored-by: Scipio Wright <scipiowright@gmail.com>
This commit is contained in:
Danaël V 2023-11-15 13:18:57 -05:00 committed by GitHub
parent bf8432faa7
commit 28a20391ab
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 28 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
docs/contributing.md
View File

@ -1,16 +1,33 @@
# Contributing # Contributing
Contributions are welcome. We have a few requests of any new contributors. Contributions are welcome. We have a few requests for new contributors:
* Follow styling as designated in our [styling documentation](/docs/style.md). * **Follow styling guidelines.**
* Ensure that all changes which affect logic are covered by unit tests. Please take a look at the [code style documentation](/docs/style.md)
* Do not introduce any unit test failures/regressions. to ensure ease of communication and uniformity.
* Turn on automated github actions in your fork to have github run all the unit tests after pushing. See example below:
* **Ensure that critical changes are covered by tests.**
It is strongly recommended that unit tests are used to avoid regression and to ensure everything is still working.
If you wish to contribute by adding a new game, please take a look at the [logic unit test documentation](/docs/world%20api.md#tests).
If you wish to contribute to the website, please take a look at [these tests](/test/webhost).
* **Do not introduce unit test failures/regressions.**
Archipelago supports multiple versions of Python. You may need to download older Python versions to fully test
your changes. Currently, the oldest supported version is [Python 3.8](https://www.python.org/downloads/release/python-380/).
It is recommended that automated github actions are turned on in your fork to have github run all of the unit tests after pushing.
You can turn them on here:
![Github actions example](./img/github-actions-example.png) ![Github actions example](./img/github-actions-example.png)
Otherwise, we tend to judge code on a case to case basis. Other than these requests, we tend to judge code on a case by case basis.
For adding a new game to Archipelago and other documentation on how Archipelago functions, please see For contribution to the website, please refer to the [WebHost README](/WebHostLib/README.md).
[the docs folder](/docs/) for the relevant information and feel free to ask any questions in the #archipelago-dev
channel in our [Discord](https://archipelago.gg/discord). If you want to contribute to the core, you will be subject to stricter review on your pull requests. It is recommended
If you want to merge a new game, please make sure to read the responsibilities as that you get in touch with other core maintainers via the [Discord](https://archipelago.gg/discord).
If you want to add Archipelago support for a new game, please take a look at the [adding games documentation](/docs/adding%20games.md), which details what is required
to implement support for a game, as well as tips for how to get started.
If you want to merge a new game into the main Archipelago repo, please make sure to read the responsibilities as a
[world maintainer](/docs/world%20maintainer.md). [world maintainer](/docs/world%20maintainer.md).
For other questions, feel free to explore the [main documentation folder](/docs/) and ask us questions in the #archipelago-dev channel
of the [Discord](https://archipelago.gg/discord).