Skip to content

Commit d042af4

Browse files
ioncakephperioncakephper
committed
docs(project): Add contributing guide, issue templates, and governance files
1 parent acf6e32 commit d042af4

File tree

8 files changed

+320
-0
lines changed

8 files changed

+320
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug Report
3+
about: Report a reproducible bug
4+
title: "[BUG] <short description of bug>"
5+
labels: ["bug", "triage"]
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+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. iOS]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
30+
31+
**Smartphone (please complete the following information):**
32+
- Device: [e.g. iPhone6]
33+
- OS: [e.g. iOS8.1]
34+
- Browser [e.g. stock browser, safari]
35+
- Version [e.g. 22]
36+
37+
**Additional context**
38+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/documentation_issue.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Documentation Issue
3+
about: Report an issue with the documentation
4+
title: "[DOCS] <short description of documentation issue>"
5+
labels: ["documentation", "triage"]
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the documentation issue**
11+
A clear and concise description of what the issue is with the documentation.
12+
13+
**URL to the relevant documentation**
14+
Provide the URL to the specific documentation page that has the issue.
15+
16+
**Expected improvement or correction**
17+
A clear and concise description of how you think the documentation should be improved or corrected.
18+
19+
**Additional context**
20+
Add any other context about the documentation issue here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for this project
4+
title: "[FEATURE] <short description of feature>"
5+
labels: ["enhancement", "triage"]
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.

‎.github/ISSUE_TEMPLATE/general_question.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: General Question
3+
about: Ask a general question about the project
4+
title: "[QUESTION] <short description of question>"
5+
labels: ["question", "triage"]
6+
assignees: ''
7+
8+
---
9+
10+
**What is your question?**
11+
A clear and concise description of your question.
12+
13+
**Context**
14+
Add any other context that might be helpful for answering your question.

‎CONTRIBUTING.md‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
# Contributing to repo-description
2+
3+
We welcome contributions to `repo-description`! Whether it's bug reports, feature requests, or code contributions, your help is greatly appreciated.
4+
5+
Please note that this project is released with a [Code of Conduct](RULES_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms.
6+
7+
## How Can I Contribute?
8+
9+
### Reporting Bugs
10+
11+
If you find a bug, please open an issue on our [GitHub Issues page](https://github.com/IonGireada/repo-description/issues). When reporting a bug, please include:
12+
13+
* A clear and concise description of the bug.
14+
* Steps to reproduce the behavior.
15+
* Expected behavior.
16+
* Screenshots or error messages if applicable.
17+
* Your operating system and Node.js version.
18+
19+
### Suggesting Enhancements
20+
21+
Have an idea for a new feature or an improvement to an existing one? We'd love to hear it! Please open an issue on our [GitHub Issues page](https://github.com/IonGireada/repo-description/issues) and describe your suggestion.
22+
23+
### Code Contributions
24+
25+
We welcome pull requests! To contribute code:
26+
27+
1. **Fork the repository** on GitHub.
28+
2. **Clone your forked repository** to your local machine.
29+
```bash
30+
git clone https://github.com/YOUR_USERNAME/repo-description.git
31+
cd repo-description
32+
```
33+
3. **Create a new branch** for your feature or bug fix.
34+
```bash
35+
git checkout -b feature/your-feature-name
36+
# or
37+
git checkout -b bugfix/issue-description
38+
```
39+
4. **Set up your development environment:**
40+
```bash
41+
npm install
42+
```
43+
5. **Make your changes.** Ensure your code adheres to the project's coding style (run `npm run format` and `npm run lint:fix`).
44+
6. **Write tests** for your changes.
45+
7. **Run tests** to ensure everything is working correctly.
46+
```bash
47+
npm test
48+
```
49+
8. **Commit your changes** with a clear and descriptive commit message.
50+
```bash
51+
git commit -m "feat: Add new feature"
52+
# or
53+
git commit -m "fix: Fix bug in X"
54+
```
55+
9. **Push your branch** to your forked repository.
56+
```bash
57+
git push origin feature/your-feature-name
58+
```
59+
10. **Open a Pull Request** to the `main` branch of the original repository. Provide a clear description of your changes and reference any related issues.
60+
61+
## Development Setup
62+
63+
To get started with development, you'll need Node.js installed.
64+
65+
1. Clone the repository: `git clone https://github.com/IonGireada/repo-description.git`
66+
2. Navigate to the project directory: `cd repo-description`
67+
3. Install dependencies: `npm install`
68+
69+
You can then use the scripts defined in `package.json` for linting, formatting, testing, and running the CLI locally.
70+
71+
## Code Style
72+
73+
This project uses ESLint and Prettier to enforce code style. Please ensure your code is formatted and linted correctly before submitting a pull request.
74+
75+
* Format your code: `npm run format`
76+
* Lint your code: `npm run lint`
77+
* Fix linting issues: `npm run lint:fix`
78+
79+
Thank you for contributing!

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Ion Gireada
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -201,6 +201,14 @@ Options:
201201

202202
<!-- end-doc-gen -->
203203

204+
## Contributing
205+
206+
We welcome contributions to `repo-description`! Please see our [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on how to contribute, including reporting bugs, suggesting enhancements, and making code contributions.
207+
208+
## License
209+
210+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
211+
204212
## Acknowledgments
205213

206214
<!-- doc-gen ACKNOWLEDGEMENTS -->

‎RULES_OF_CONDUCT.md‎

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
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 at [INSERT CONTACT METHOD].
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 sustained pattern of inappropriate
85+
behavior.
86+
87+
**Consequence**: A warning with consequences for continued behavior. No
88+
interaction with the involved people for a specified period of time, including
89+
unsolicited interaction with those enforcing the Code of Conduct. This includes
90+
avoiding interaction in community spaces as well as external channels like social
91+
media. Violating these terms may lead to a temporary or permanent ban.
92+
93+
### 3. Temporary Ban
94+
95+
**Community Impact**: A serious violation of community standards, including
96+
sustained inappropriate behavior.
97+
98+
**Consequence**: A temporary ban from any sort of interaction or public
99+
communication with the community for a specified period of time. No public or
100+
private interaction with the involved people, including unsolicited interaction
101+
with those enforcing the Code of Conduct, is allowed during this period.
102+
Violating these terms may lead to a permanent ban.
103+
104+
### 4. Permanent Ban
105+
106+
**Community Impact**: Demonstrating a pattern of violation of community standards,
107+
including sustained inappropriate behavior, harassment of an individual, or
108+
aggression toward or disparagement of classes of individuals.
109+
110+
**Consequence**: A permanent ban from any sort of public interaction within the
111+
community.
112+
113+
## Attribution
114+
115+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
116+
version 2.1, available at
117+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
118+
119+
[homepage]: https://www.contributor-covenant.org
120+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html

0 commit comments

Comments
 (0)