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.

Sign up for GitHub

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

Minor updates for conciseness, mostly #2

Merged
merged 1 commit into from
Oct 7, 2023
Merged

Minor updates for conciseness, mostly #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 13 additions & 13 deletions docs/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,30 +3,30 @@ Contributions are welcome. We have a few requests for new contributors:

* **Follow styling guidelines.**
We have designated styling guideline to ensure uniformity and ease of communication. Please take a look at
our [styling documentation](/docs/style.md).
the [styling documentation](/docs/style.md).

* **Ensure that all changes are covered by unit 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 [following tests](/test/webhost).
If you wish to contribute to the website, please take a look at [these tests](/test/webhost).

* **Do not introduce any unit test failures/regressions.**
To note, Archipelago supports multiple versions of Python. You may need to download older Python versions to fully test
* **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 the unit tests after pushing.
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)

Other than these requests, we tend to judge code on a case to case basis. For contribution to the website, please also refer to
this [document](/WebHostLib/README.md).
Other than these requests, we tend to judge code on a case by case basis. For contribution to the website, please refer to
[this document](/WebHostLib/README.md).

If you want to contribute to the core, you will be subject to stricter review on your pull requests. It is also recommended
that you get in touch with other core maintainers via 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
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) detailing what is required
for implementing a game, as well as tips for how to get started.
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).

For any other questions, feel free to explore the [main documentation folder](/docs/) and ask us questions in the #archipelago-dev channel
of our [Discord](https://archipelago.gg/discord).
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).