-
Notifications
You must be signed in to change notification settings - Fork 312
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Create CONTRIBUTING.md * Update Info about Contribute in README.md Since details about contributions have moved to its dedicaed file, the contribution section in Readme is updated accordinlgy. * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md --------- Co-authored-by: ludamad <[email protected]>
- Loading branch information
Showing
2 changed files
with
26 additions
and
2 deletions.
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 |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# Contributing Guidelines | ||
|
||
There are many ways to contribute to Aztec Monorepo. | ||
|
||
## Opening an issue | ||
|
||
You can [open an issue] to suggest a feature or report a minor bug. | ||
|
||
Before opening an issue, be sure to search through the existing open and closed issues, and consider posting a comment in one of those instead. | ||
|
||
When requesting a new feature, include as many details as you can, especially around the use cases that motivate it. Features are prioritized according to the impact they may have on the ecosystem, so we appreciate information showing that the impact could be high. | ||
|
||
[open an issue]: https://github.com/AztecProtocol/aztec-packages/issues/new | ||
|
||
## Submitting a pull request | ||
|
||
If you would like to contribute code or documentation you may do so by forking the repository and submitting a pull request. | ||
|
||
Any non-trivial code contribution must be first discussed with the maintainers in an issue (see [Opening an issue](#opening-an-issue)). Only very minor changes are accepted without prior discussion. | ||
|
||
When opening the pull request you will be presented with a template and a series of instructions. Read through it carefully and follow all the steps. Expect a review and feedback from the maintainers afterward. | ||
|
||
If you're looking for a good place to start, look for issues labeled ["good first issue"](https://github.com/AztecProtocol/aztec-packages/labels/good%20first%20issue)! |
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