Skip to content

Commit

Permalink
Docs: add info to turn on github actions (ArchipelagoMW#2264)
Browse files Browse the repository at this point in the history
* add info to turn on github actions

* add missing image

* add when pushing

* reduce picture size

* mention editing actions on your fork instead
  • Loading branch information
kindasneaki authored Oct 5, 2023
1 parent 115a6b6 commit bb09811
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/contributing.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# Contributing
Contributions are welcome. We have a few requests of any 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.
* Follow styling as designated in our [styling documentation](/docs/style.md).
* Turn on automated github actions in your fork to have github run all the unit tests after pushing. See example below:
![Github actions example](./img/github-actions-example.png)

Otherwise, we tend to judge code on a case to case basis.

Expand Down
Binary file added docs/img/github-actions-example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit bb09811

Please sign in to comment.