Skip to content

Commit 0ec7799

Browse files
authored
Merge pull request #144 from Vaibhav-Kulshreshtha7/docs/add-CONTRIBUTING-md
docs: add CONTRIBUTING.md with clear contribution guidelines
2 parents cc9b847 + 8bdc5e8 commit 0ec7799

File tree

2 files changed

+102
-55
lines changed

2 files changed

+102
-55
lines changed

CONTRIBUTING.md

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
# Contributing to Amour Editorials 💜
2+
3+
Thank you for your interest in contributing to **Amour Editorials**!
4+
We welcome contributions from everyone — whether you’re a beginner or an experienced developer, designer, writer, or tester.
5+
6+
7+
## 📜 Code of Conduct
8+
9+
This project follows our [Code of Conduct](CODE_OF_CONDUCT.md).
10+
By participating, you agree to uphold these standards.
11+
If you witness or experience unacceptable behavior, please report it to the maintainers.
12+
13+
14+
## 🚀 Ways to Contribute
15+
16+
There are many ways to contribute:
17+
18+
- 📃 Improve documentation
19+
20+
- 🐞 Report or fix bugs
21+
22+
- ✨ Add new features
23+
24+
- 🎨 Improve UI/UX
25+
26+
27+
## 🛠 How to Contribute
28+
29+
### 1. Fork the Repository
30+
Start by forking the repository to your GitHub account.
31+
32+
### 2. Clone Your Fork
33+
Clone the repository to your local machine using:
34+
35+
```bash
36+
$ git clone https://github.com/<your-username>/Amour-Editorial-Website.git
37+
```
38+
39+
### 3. Create a New Branch
40+
Create a branch for your contribution:
41+
42+
```bash
43+
$ git checkout -b <branch-name>
44+
```
45+
46+
### 4. Make Your Changes
47+
Add new pages, new algorithms, improve documentation, or fix any issues. Be sure to:
48+
- Write clean, well-commented code
49+
- Ensure you don’t break existing features and that your solution is correct and efficient
50+
51+
### 5. Commit Your Changes
52+
Commit your changes with a descriptive commit message:
53+
54+
```bash
55+
$ git commit -m "Added [the changes]"
56+
```
57+
58+
### 6. Push Your Fork
59+
Push your changes to your forked repository:
60+
61+
```bash
62+
$ git push origin <branch-name>
63+
```
64+
65+
### 7. Create a Pull Request
66+
Go to the original repo → New Pull Request.
67+
Explain what you changed and why.
68+
69+
70+
## 📌 Contribution Guidelines
71+
72+
- 🧹 Maintain code style & lint rules
73+
- 🚫 Don’t break existing features
74+
- 🧪 Write/modify tests (if applicable)
75+
- 💬 Be clear in PR descriptions
76+
- 🙌 Respect others and give constructive feedback
77+
78+
79+
## 📚 Documentation
80+
81+
Please update documentation when adding or modifying features:
82+
83+
- Update `README.md` if necessary
84+
- Add inline comments for complex code
85+
86+
87+
## 💬 Communication
88+
If you have questions, suggestions, or need help:
89+
90+
Start a discussion in the GitHub Discussions (if enabled).
91+
92+
Open a new issue if you're facing a bug or want to propose an enhancement.
93+
94+
For urgent matters, mention maintainers directly in your issue or PR using @maintainer-username.
95+
96+
97+
Stay respectful, constructive, and inclusive in all your interactions.
98+
---
99+
100+
Thank you for your contributions! Together, we can build something amazing. ✨

README.md

Lines changed: 2 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -149,61 +149,8 @@ Amour-Editorial-Website/
149149

150150
## 🤝 Contributing
151151

152-
We welcome contributions from developers, designers, writers, and testers! 💜
153-
154-
### How to Contribute
155-
156-
1. **Fork** the repository
157-
2. **Clone** to local
158-
3. **Create a new branch** for your feature/bug
159-
4. **Commit changes** with meaningful messages
160-
5. **Push** and create a Pull Request
161-
6. **Raise a issue**
162-
We appreciate you taking the time to improve the project! Here’s how to raise an issue effectively:
163-
164-
**Check for Existing Issues**
165-
-Browse through existing issues to avoid duplicates.
166-
167-
**Use a Clear Title**
168-
-Make your title short but descriptive (e.g., "Navbar overlaps logo on mobile").
169-
170-
**Describe the Issue in Detail**
171-
-Explain what the issue is and why it matters.
172-
-Mention the expected behavior vs. actual behavior.
173-
-Include steps to reproduce the problem (if it's a bug).
174-
175-
**Attach Relevant Media (if applicable)**
176-
-Screenshots, GIFs, or terminal logs help speed up understanding.
177-
178-
**Use Appropriate Labels**
179-
-Add labels like bug, feature, enhancement, good first issue, etc.
180-
181-
**Be Respectful and Constructive**
182-
-Keep communication kind and focused on solutions.
183-
7. **Create a Pull Request**
184-
Go to your forked repo on GitHub.
185-
You'll see a prompt to "Compare & pull request".
186-
187-
Click it.
188-
189-
Fill in the PR title and description:
190-
✅ Title: docs: add contribution guidelines for issues and PRs
191-
✅ Description: Briefly explain what you did.
192-
Example:
193-
This PR adds a new section to the README with clear steps on how contributors can raise issues and submit PRs, as requested in Issue #<issue-number>.
194-
195-
Submit the PR.
196-
8. **Comment on the Issue**
197-
If the task was assigned via an Issue, comment something like:
198-
I have created a PR that addresses this. Please review it here: [#PR-Link]
199-
200-
### Contribution Guidelines
201-
202-
- 🧹 Maintain code style & lint rules
203-
- 🚫 Don’t break existing features
204-
- 🧪 Write/modify tests (if applicable)
205-
- 💬 Be clear in PR descriptions
206-
- 🙌 Respect others and give constructive feedback
152+
We welcome contributions to make EventStack even better!
153+
Please read our [Contributing Guidelines](CONTRIBUTING.md) before submitting a pull request.
207154

208155
---
209156

0 commit comments

Comments
 (0)