Skip to content

Commit

Permalink
docs: re-write CONTRIBUTING.md (#36)
Browse files Browse the repository at this point in the history
* docs: re-write CONTRIBUTING.md

* build: add changelog to gitignore
  • Loading branch information
ripytide authored Oct 27, 2024
1 parent 5a421c4 commit fd88dbc
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 7 deletions.
20 changes: 13 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
# Contributing

Thank you for considering to contribute to `metapac`. The recommended workflow is
this:
Thank you for considering to contribute to `metapac`, all contributions are
welcome!

1. Open a github issue, mention that you would like to fix the issue in a PR.
2. Wait for approval.
3. Fork the repository and implement your fix / feature.
4. Make sure your code generates no warnings, and passes `rustfmt` and `clippy`.
5. Open the pull request.
There are no hard rules for this project but there are some general
guidelines to avoid problems:

- Open github issues for any features/bugs/issues you want to raise, but
try to check the existing issues to avoid duplicates.
- Try to comment on an issue before attempting any pull requests to avoid
multiple people working on the same feature at the same time which would
result in wasted effort.
- Discussion is always welcome on issues since there are usually multiple
ways to fix/implement every bug/feature and discussion is the best and
easiest way to select the best solution.
2 changes: 2 additions & 0 deletions typos.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[files]
extend-exclude = ["CHANGELOG.md"]

0 comments on commit fd88dbc

Please sign in to comment.