Skip to content

Commit 8bdc5e8

Browse files
docs: link CONTRIBUTING.md in README for better visibility
Updated the README.md to include a direct link to CONTRIBUTING.md, making it easier for new contributors to access contribution guidelines.
1 parent c05567b commit 8bdc5e8

File tree

1 file changed

+2
-55
lines changed

1 file changed

+2
-55
lines changed

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)