Skip to content

Commit e7df7e4

Browse files
alpha912alpha912
committed
docs: add contributing guidelines and Code of Conduct
1 parent 8267da6 commit e7df7e4

File tree

2 files changed

+204
-0
lines changed

2 files changed

+204
-0
lines changed

‎CODE_OF_CONDUCT.md‎

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

‎CONTRIBUTING.md‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
# Contributing to CodebaseMD
2+
3+
We welcome contributions to **CodebaseMD**! Whether you’re fixing bugs, adding new features, improving documentation, or suggesting ideas, we appreciate your involvement. Before getting started, please review the following guidelines.
4+
5+
## How to Contribute
6+
7+
### 1. Fork the Repository
8+
9+
- Go to the [CodebaseMD GitHub repository](https://github.com/alpha912/codebase-md).
10+
- Click on the **Fork** button in the top-right corner to create a copy of the repository under your GitHub account.
11+
12+
### 2. Clone the Fork
13+
14+
Once you have forked the repository, clone it to your local machine:
15+
16+
```
17+
git clone https://github.com/your-username/codebase-md.git
18+
cd codebase-md
19+
```
20+
21+
### 3. Create a Branch
22+
23+
Create a new branch for your work. This makes it easier to isolate your changes and submit them as a pull request.
24+
25+
```
26+
git checkout -b feature/my-new-feature
27+
```
28+
29+
### 4. Make Your Changes
30+
31+
- For new features, be sure to update/add relevant tests.
32+
- For bug fixes, provide steps in your pull request for testing the fix.
33+
34+
### 5. Lint and Test Your Changes
35+
36+
Ensure that the code is clean and free of linting issues by running the following:
37+
38+
```
39+
npm run lint
40+
```
41+
42+
If you made significant changes, also run tests to ensure everything works correctly:
43+
44+
```
45+
npm test
46+
```
47+
48+
### 6. Commit Your Changes
49+
50+
Write meaningful commit messages, following these guidelines:
51+
- Start with a lowercase verb, such as `fix:`, `feat:`, or `docs:`.
52+
- Keep the commit message short but descriptive.
53+
54+
Example commit message:
55+
56+
```
57+
git add .
58+
git commit -m "fix: resolve export error for unsupported file types"
59+
```
60+
61+
### 7. Push the Branch
62+
63+
Push your changes to your forked repository:
64+
65+
```
66+
git push origin feature/my-new-feature
67+
```
68+
69+
### 8. Submit a Pull Request
70+
71+
Go to your fork on GitHub, and you should see a prompt to submit a pull request. Provide a meaningful description of the changes in the pull request, referencing any issues that are related.
72+
73+
We will review your pull request as soon as possible and provide feedback if needed.
74+
75+
## Guidelines
76+
77+
- **Respect existing code standards**: Follow the coding style and conventions used in the project.
78+
- **Test thoroughly**: Ensure your changes don’t break existing functionality.
79+
- **Stay focused**: Stick to the purpose of your pull request, and try not to include unrelated changes.
80+
81+
## Reporting Bugs
82+
83+
If you encounter a bug, please submit an issue in the [issue tracker](https://github.com/alpha912/codebase-md/issues) and include:
84+
- Steps to reproduce the bug.
85+
- Expected and actual results.
86+
- Any additional information, such as screenshots or error logs.
87+
88+
## Feature Requests
89+
90+
Feel free to open a new issue in the [issue tracker](https://github.com/alpha912/codebase-md/issues) for feature requests. Make sure to provide as much context as possible to help us understand the need for the new feature.
91+
92+
---
93+
94+
Thank you for your contributions! 🎉

0 commit comments

Comments
 (0)