-
Notifications
You must be signed in to change notification settings - Fork 751
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
Docs: Rework of Contributing.md #2278
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
607238a
Update contributing.md
ReverM 4017caf
Update docs/contributing.md
ReverM 05bb68f
Update contributing.md
ReverM fe0a755
Merge branch 'main' into doc-rework
ReverM a306b11
Update docs/contributing.md
ReverM d9f0d06
Update docs/contributing.md
ReverM 575b92a
Update docs/contributing.md
ReverM File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,33 @@ | ||
# 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). | ||
* Ensure that all changes which affect logic are covered by unit tests. | ||
* Do not introduce any unit test failures/regressions. | ||
* Turn on automated github actions in your fork to have github run all the unit tests after pushing. See example below: | ||
* **Follow styling guidelines.** | ||
Please take a look at the [code style documentation](/docs/style.md) | ||
to ensure ease of communication and uniformity. | ||
|
||
* **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) | ||
|
||
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 contribution to the website, please refer to the [WebHost README](/WebHostLib/README.md). | ||
|
||
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), 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 adding a new game to Archipelago and other documentation on how Archipelago functions, please see | ||
[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 merge a new game, please make sure to read the responsibilities as | ||
[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). |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"please make sure to read the responsibilities as a world maintainer" is a little awkward. Consider one of:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"please make sure to read the [responsibilities as a world maintainer documentation]"
I think that would be the most clear here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I will consider those changes
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
anything?