|
| 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. ✨ |
0 commit comments