mirror of
https://github.com/semaphore-protocol/semaphore.git
synced 2026-04-28 03:00:41 -04:00
c973bab503
* docs: update contributing file * docs: update pull request template * docs: add new issue link to contributing
41 lines
2.1 KiB
Markdown
41 lines
2.1 KiB
Markdown
<!-- Please refer to our CONTRIBUTING documentation for any questions on submitting a pull request. -->
|
|
<!-- Provide a general summary of your changes in the Title above. -->
|
|
|
|
## Description
|
|
|
|
<!-- Describe your changes in detail. -->
|
|
<!-- You may want to answer some of the following questions: -->
|
|
<!-- What kind of change does this PR introduce?** (Bug fix, feature, docs update, ...) -->
|
|
<!-- What is the current behavior?** (You can also link to an open issue here) -->
|
|
<!-- What is the new behavior (if this is a feature change)? -->
|
|
<!-- Does this PR introduce a breaking change?** (What changes might users need to make in their application due to this PR?) -->
|
|
|
|
## Related Issue(s)
|
|
|
|
<!-- This project accepts pull requests related to open issues. -->
|
|
<!-- If suggesting a new feature or change, please discuss it in an issue first. -->
|
|
<!-- If fixing a bug, there should be an issue describing it with steps to reproduce. -->
|
|
<!-- Please link to the issue(s) here -->
|
|
|
|
<!-- Closes # -->
|
|
<!-- Fixes # -->
|
|
|
|
## Other information
|
|
|
|
<!-- Any other information that is important to this PR such as screenshots of how the component looks before and after the change. -->
|
|
<!-- Feel free to remove this section if you will not use it. -->
|
|
|
|
## Checklist
|
|
|
|
<!-- Please check if the PR fulfills these requirements. -->
|
|
|
|
- [ ] I have performed a self-review of my code
|
|
- [ ] I have commented my code, particularly in hard-to-understand areas
|
|
- [ ] My changes generate no new warnings
|
|
- [ ] I have run `yarn format` and `yarn lint` without getting any errors
|
|
- [ ] I have added tests that prove my fix is effective or that my feature works
|
|
- [ ] New and existing unit tests pass locally with my changes
|
|
|
|
> [!IMPORTANT]
|
|
> We do not accept pull requests for minor grammatical fixes (e.g., correcting typos, rewording sentences) or for fixing broken links, unless they significantly improve clarity or functionality. These contributions, while appreciated, are not a priority for merging. If you notice any of these issues, please create a [GitHub Issue](https://github.com/semaphore-protocol/semaphore/issues/new?template=BLANK_ISSUE) to report them so they can be properly tracked and addressed.
|