Skip to content

Commit ec01121

Browse files
vplasenciavplasencia
committed
chore: add .github folder
The .github folder is added with some issue templates, codeowners and pull request template files
1 parent a108b48 commit ec01121

File tree

6 files changed

+127
-0
lines changed

6 files changed

+127
-0
lines changed

Diff for: ‎.github/CODEOWNERS

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @vplasencia @vivianjeng @KimiWu123

Diff for: ‎.github/ISSUE_TEMPLATE/---bug.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: "\U0001F41E Bug"
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: "bug \U0001F41B"
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
16+
1. Go to '...'
17+
2. Click on '....'
18+
3. Scroll down to '....'
19+
4. See error
20+
21+
**Expected behavior**
22+
A clear and concise description of what you expected to happen.
23+
24+
**Screenshots**
25+
If applicable, add screenshots to help explain your problem.
26+
27+
**Technologies (please complete the following information):**
28+
29+
- Node.js version
30+
- NPM version
31+
- Solidity version
32+
33+
**Additional context**
34+
Add any other context about the problem here.

Diff for: ‎.github/ISSUE_TEMPLATE/---feature.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: "\U0001F680 Feature"
3+
about: Suggest an idea for Semaphore
4+
title: ''
5+
labels: 'feature :rocket:'
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

Diff for: ‎.github/ISSUE_TEMPLATE/---package.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: "\U0001F4E6 Package"
3+
about: Propose a new Semaphore package
4+
title: ''
5+
labels: 'feature :rocket:'
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the package you'd like**
11+
A clear and concise description of the type of package you have in mind.
12+
13+
**Additional context**
14+
Add any other context about the package here.

Diff for: ‎.github/ISSUE_TEMPLATE/♻️-refactoring.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: "♻️ Refactoring"
3+
about: 'about: Suggest any improvements for this project'
4+
title: ''
5+
labels: 'refactoring :recycle:'
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the improvement you're thinking about**
11+
A clear and concise description of what you think could improve the code.
12+
13+
**Describe alternatives you've considered**
14+
A clear and concise description of any alternative solutions you've considered.
15+
16+
**Additional context**
17+
Add any other context or screenshots about the improvement request here.

Diff for: ‎.github/pull_request_template.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
<!-- Please refer to our CONTRIBUTING documentation for any questions on submitting a pull request. -->
2+
<!-- Provide a general summary of your changes in the Title above. -->
3+
4+
## Description
5+
6+
<!-- Describe your changes in detail. -->
7+
<!-- You may want to answer some of the following questions: -->
8+
<!-- What kind of change does this PR introduce?** (Bug fix, feature, docs update, ...) -->
9+
<!-- What is the current behavior?** (You can also link to an open issue here) -->
10+
<!-- What is the new behavior (if this is a feature change)? -->
11+
<!-- Does this PR introduce a breaking change?** (What changes might users need to make in their application due to this PR?) -->
12+
13+
## Related Issue(s)
14+
15+
<!-- This project accepts pull requests related to open issues. -->
16+
<!-- If suggesting a new feature or change, please discuss it in an issue first. -->
17+
<!-- If fixing a bug, there should be an issue describing it with steps to reproduce. -->
18+
<!-- Please link to the issue(s) here -->
19+
20+
<!-- Closes # -->
21+
<!-- Fixes # -->
22+
23+
## Other information
24+
25+
<!-- Any other information that is important to this PR such as screenshots of how the component looks before and after the change. -->
26+
<!-- Feel free to remove this section if you will not use it. -->
27+
28+
## Checklist
29+
30+
<!-- Please check if the PR fulfills these requirements. -->
31+
32+
- [ ] I have read and understand the [contributor guidelines](https://github.com/semaphore-protocol/semaphore-rs/blob/main/CONTRIBUTING.md) and [code of conduct](https://github.com/semaphore-protocol/semaphore-rs/blob/main/CODE_OF_CONDUCT.md).
33+
- [ ] I have performed a self-review of my code
34+
- [ ] I have commented my code, particularly in hard-to-understand areas
35+
- [ ] My changes generate no new warnings
36+
- [ ] I have run `yarn style` without getting any errors
37+
- [ ] I have added tests that prove my fix is effective or that my feature works
38+
- [ ] New and existing unit tests pass locally with my changes
39+
40+
> [!IMPORTANT]
41+
> We do not accept minor grammatical fixes (e.g., correcting typos, rewording sentences) unless they significantly improve clarity in technical documentation. These contributions, while appreciated, are not a priority for merging. If there is a grammatical error feel free to message the team.

0 commit comments

Comments
 (0)