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

Jump to bottom

Docs: improve contributing sign posting #2888

Merged
merged 6 commits into from
May 29, 2024
Merged

Docs: improve contributing sign posting #2888

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f0e54f4
Docs: improve sign posting for contributing
alwaysintreble Mar 3, 2024
68c3660
Merge branch 'main' into roadsign_contributing
alwaysintreble Mar 31, 2024
7e21d98
fix styling as per the style guide
alwaysintreble Mar 31, 2024
ae2e071
address review comments
alwaysintreble Mar 31, 2024
aecc905
apply medic's feedback
alwaysintreble May 9, 2024
d47eb00
Merge branch 'refs/heads/main' into roadsign_contributing
alwaysintreble May 9, 2024
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
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,8 @@ This project makes use of multiple other projects. We wouldn't be here without t
* [Ocarina of Time Randomizer](https://github.com/TestRunnerSRL/OoT-Randomizer)

## Contributing
For contribution guidelines, please see our [Contributing doc.](/docs/contributing.md)
To contribute to Archipelago, including the WebHost, core program, or by adding a new game, see our
[Contributing guidelines.](/docs/contributing.md)
alwaysintreble marked this conversation as resolved.
Show resolved Hide resolved

## FAQ
For Frequently asked questions, please see the website's [FAQ Page.](https://archipelago.gg/faq/en/)
Expand Down
9 changes: 5 additions & 4 deletions docs/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Contributing
Contributions are welcome. We have a few requests for new contributors:
Contributions are welcome.
We have a few asks of contributors, whether they be for core, webhost, or new game contributions:
alwaysintreble marked this conversation as resolved.
Show resolved Hide resolved

* **Follow styling guidelines.**
Please take a look at the [code style documentation](/docs/style.md)
Expand All @@ -13,7 +14,7 @@ If you wish to contribute to the website, please take a look at [these tests](/t
* **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.
It is recommended that automated github actions are turned on in your fork to have github run unit tests after pushing.
You can turn them on here:
![Github actions example](./img/github-actions-example.png)

Expand All @@ -24,8 +25,8 @@ For contribution to the website, please refer to the [WebHost README](/WebHostLi
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 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.
alwaysintreble marked this conversation as resolved.
Show resolved Hide resolved
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).

Expand Down
Loading