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

Witness: Add French and German Setup Documentation #2527

Open
wants to merge 24 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
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
Prev Previous commit
Next Next commit
Update contributing.md
Added non-AP World specific information
  • Loading branch information
ReverM committed Oct 4, 2023
commit e172ada9c5db02aa26399922d1984927c1000dc7
13 changes: 9 additions & 4 deletions docs/contributing.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# Contributing
Contributions are welcome. We have a few requests of any new contributors.

* **Ensure that all changes which affect logic are covered by unit tests.**
It is strongly recommended that unit tests are used to avoid regression and confirm that the logic is working.
To implement them, please take a look at [their documentation](/docs/world%20api.md#tests).
* **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](/tree/main/test/webhost).
* **Do not introduce any unit test failures/regressions.**
To do so, it is recommended that Github actions are turned on to automatically run all unit tests when pushing.
You can turn this setting on here. (insert image)
Expand All @@ -12,7 +13,11 @@ You can turn this setting on here. (insert image)
We have designated styling guideline to ensure uniformity and ease of communication. Please take a look at
our [styling documentation](/docs/style.md).

Other than these requests, we tend to judge code on a case to case basis.
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).

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 mainteners via our [Discord](https://archipelago.gg/discord).

If you want to add a new game to Archipelago, please take a look at this [document](/docs/adding%20games.md) detailing what is required
for implementing a game (as well as tips for how to get started).
Expand Down