Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
50 lines (37 loc) · 1.9 KB

CONTRIBUTING.md

File metadata and controls

50 lines (37 loc) · 1.9 KB

🚀 Contributing to Whooshh

We love open-source contributions! Whether you're fixing a bug, adding a new feature, or improving documentation, your contributions are highly appreciated. Follow the guidelines below to get started. 🌟

🛠️ How to Contribute

1️⃣ Fork the Repository – Click the Fork button on the top right of the Whooshh repository.
2️⃣ Clone Your Fork – Download your forked repository to your local machine:

git clone https://github.com/your-username/Whooshh.git

3️⃣ Create a New Branch – Use a descriptive branch name for your feature or fix:

git checkout -b feature-branch-name

4️⃣ Make Changes – Implement your improvements, ensuring the code is clean and well-documented. 5️⃣ Commit Your Changes – Write clear and meaningful commit messages:

git commit -m "Added a new feature to enhance UI"

6️⃣ Push to GitHub – Upload your changes to your forked repository:

git push origin feature-branch-name

7️⃣ Create a Pull Request – Navigate to the original repository and submit a pull request (PR). Provide a detailed description of your changes.

🔥 Contribution Guidelines

✔️ Follow Clean Code Practices – Keep the code readable and maintainable.
✔️ Test Your Changes – Ensure that your code works before submitting.
✔️ Stay Updated – Sync your branch with the latest code:

git pull upstream main

✔️ Respect the Community – Be kind, patient, and collaborative! 😊

💡 Need Help?

If you have any questions or need guidance, feel free to open an issue or start a discussion in the repository. We’re happy to help! 🚀

Thank you for contributing to Whooshh! 💙 Your efforts make this project better for everyone. 🎉