Skip to content

Commit 7fbfc5d

Browse files
vplasenciavplasencia
committed
chore: add contributing and pull request template files
1 parent 6dfab89 commit 7fbfc5d

4 files changed

Lines changed: 275 additions & 1 deletion

File tree

‎.github/pull_request_template.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
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 performed a self-review of my code
33+
- [ ] I have commented my code, particularly in hard-to-understand areas
34+
- [ ] I have added tests that prove my fix is effective or that my feature works
35+
- [ ] New and existing unit tests pass locally with my changes
36+
37+
> [!IMPORTANT]
38+
> 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/privacy-ethereum/zkID/issues/new?template=BLANK_ISSUE) to report them so they can be properly tracked and addressed.

‎CODE_OF_CONDUCT.md‎

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
- Demonstrating empathy and kindness toward other people
21+
- Being respectful of differing opinions, viewpoints, and experiences
22+
- Giving and gracefully accepting constructive feedback
23+
- Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
- Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
- The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
- Trolling, insulting or derogatory comments, and personal or political attacks
33+
- Public or private harassment
34+
- Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
- Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement.
63+
All complaints will be reviewed and investigated promptly and fairly.
64+
65+
All community leaders are obligated to respect the privacy and security of the
66+
reporter of any incident.
67+
68+
## Enforcement Guidelines
69+
70+
Community leaders will follow these Community Impact Guidelines in determining
71+
the consequences for any action they deem in violation of this Code of Conduct:
72+
73+
### 1. Correction
74+
75+
**Community Impact**: Use of inappropriate language or other behavior deemed
76+
unprofessional or unwelcome in the community.
77+
78+
**Consequence**: A private, written warning from community leaders, providing
79+
clarity around the nature of the violation and an explanation of why the
80+
behavior was inappropriate. A public apology may be requested.
81+
82+
### 2. Warning
83+
84+
**Community Impact**: A violation through a single incident or series
85+
of actions.
86+
87+
**Consequence**: A warning with consequences for continued behavior. No
88+
interaction with the people involved, including unsolicited interaction with
89+
those enforcing the Code of Conduct, for a specified period of time. This
90+
includes avoiding interactions in community spaces as well as external channels
91+
like social media. Violating these terms may lead to a temporary or
92+
permanent ban.
93+
94+
### 3. Temporary Ban
95+
96+
**Community Impact**: A serious violation of community standards, including
97+
sustained inappropriate behavior.
98+
99+
**Consequence**: A temporary ban from any sort of interaction or public
100+
communication with the community for a specified period of time. No public or
101+
private interaction with the people involved, including unsolicited interaction
102+
with those enforcing the Code of Conduct, is allowed during this period.
103+
Violating these terms may lead to a permanent ban.
104+
105+
### 4. Permanent Ban
106+
107+
**Community Impact**: Demonstrating a pattern of violation of community
108+
standards, including sustained inappropriate behavior, harassment of an
109+
individual, or aggression toward or disparagement of classes of individuals.
110+
111+
**Consequence**: A permanent ban from any sort of public interaction within
112+
the community.
113+
114+
## Attribution
115+
116+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
117+
version 2.0, available at
118+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
119+
120+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
121+
enforcement ladder](https://github.com/mozilla/diversity).
122+
123+
[homepage]: https://www.contributor-covenant.org
124+
125+
For answers to common questions about this code of conduct, see the FAQ at
126+
https://www.contributor-covenant.org/faq. Translations are available at
127+
https://www.contributor-covenant.org/translations.

‎CONTRIBUTING.md‎

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
# Contributing
2+
3+
:tada: Thank you for being interested in contributing to the zkID project! :tada:
4+
5+
Feel welcome and read the following sections in order to know how to ask questions and how to work on something.
6+
7+
All members of our community are expected to follow our [Code of Conduct](/CODE_OF_CONDUCT.md). Please make sure you are welcoming and friendly in all of our spaces.
8+
9+
We're really glad you're reading this, because we need volunteer developers to help this project come to fruition. 👏
10+
11+
## Issues
12+
13+
The best way to contribute to our projects is by opening a [new issue](https://github.com/privacy-ethereum/zkID/issues/new) or tackling one of the issues listed [here](https://github.com/privacy-ethereum/zkID/contribute).
14+
15+
## Pull Requests
16+
17+
Pull requests are great if you want to add a feature or fix a bug. Here's a quick guide:
18+
19+
1. Fork the repo.
20+
21+
2. Run the tests. We only take pull requests with passing tests.
22+
23+
3. Add a test for your change. Only refactoring and documentation changes require no new tests.
24+
25+
4. Make sure to check out the [Style Guide](/CONTRIBUTING.md#style-guide) and ensure that your code complies with the rules.
26+
27+
5. Make the test pass.
28+
29+
6. Commit your changes.
30+
31+
7. Push to your fork and submit a pull request on our `main` branch. Please provide us with some explanation of why you made the changes you made. For new features make sure to explain a standard use case to us.
32+
33+
> [!IMPORTANT]
34+
> 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/privacy-ethereum/zkID/issues/new?template=BLANK_ISSUE) to report them so they can be properly tracked and addressed.
35+
36+
## CI (Github Actions) Tests
37+
38+
We use GitHub Actions to test each PR before it is merged.
39+
40+
When you submit your PR (or later change that code), a CI build will automatically be kicked off. A note will be added to the PR, and will indicate the current status of the build.
41+
42+
## Style Guide
43+
44+
### Commit rules
45+
46+
For commits it is recommended to use [Conventional Commits](https://www.conventionalcommits.org).
47+
48+
Don't worry if it looks complicated, you can install and use the [`czg` command](https://cz-git.qbb.sh/cli/) and follow the interactive steps.
49+
50+
Each commit message consists of a **header**, a **body** and a **footer**. The **header** has a special format that includes a **type**, a **scope** and a **subject**:
51+
52+
<type>(<scope>): <subject>
53+
<BLANK LINE>
54+
<body>
55+
<BLANK LINE>
56+
<footer>
57+
58+
The **header** is mandatory and the **scope** of the header must contain the name of the project folder you are working on.
59+
60+
#### Type
61+
62+
The type must be one of the following:
63+
64+
- feat: A new feature
65+
- fix: A bug fix
66+
- docs: Documentation only changes
67+
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
68+
- refactor: A code change that neither fixes a bug nor adds a feature (improvements of the code structure)
69+
- perf: A code change that improves the performance
70+
- test: Adding missing or correcting existing tests
71+
- build: Changes that affect the build system or external dependencies (example scopes: gulp, npm)
72+
- ci: Changes to CI configuration files and scripts (example scopes: travis, circle)
73+
- chore: Other changes that don't modify src or test files
74+
- revert: Reverts a previous commit
75+
76+
#### Scope
77+
78+
The scope should be the name of the affected project folder (e.g. `paper`, `revocation`) (as perceived by the person reading the changelog generated from commit messages).
79+
80+
#### Subject
81+
82+
The subject contains a succinct description of the change:
83+
84+
- Use the imperative, present tense: "change" not "changed" nor "changes"
85+
- Don't capitalize the first letter
86+
- No dot (.) at the end
87+
88+
#### Body
89+
90+
Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.
91+
92+
### Branch rules
93+
94+
- There must be a `main` branch, used only for the releases.
95+
- Avoid long descriptive names for long-lived branches.
96+
- Use kebab-case (no CamelCase).
97+
- Use grouping tokens (words) at the beginning of your branch names (in a similar way to the `type` of commit).
98+
- Define and use short lead tokens to differentiate branches in a way that is meaningful to your workflow.
99+
- Use slashes to separate parts of your branch names.
100+
- Remove branch after merge if it is not important.
101+
102+
Examples:
103+
104+
```bash
105+
git branch -b docs/readme
106+
git branch -b test/a-feature
107+
git branch -b feat/sidebar
108+
git branch -b fix/b-feature
109+
```

‎LICENSE‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2025 privacy-scaling-explorations
3+
Copyright (c) 2026 Ethereum Foundation
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

0 commit comments

Comments
 (0)