Skip to content

Latest commit

 

History

History
53 lines (38 loc) · 2.44 KB

contribution-guidelines.md

File metadata and controls

53 lines (38 loc) · 2.44 KB

✨ Contribution Guidelines ✨

  1. Fork the Repository:

    • 🍴 Fork the repository to your GitHub account before embarking on your coding adventure.

  2. Branching Strategy:

    • 🌿 Create a feature branch for each contribution. Get creative with branch names!

  3. Code Style:

    • 💅 Follow the established coding conventions and style guide. Make your code sparkle!

  4. Pull Requests:

    • 🚀 Submit a pull request (PR) from your feature branch to the main repository's main branch.
    • 📝 Clearly describe the purpose of your PR and sprinkle in some emojis. Reference related issues like a pro!

  5. PR Review:

    • 🕵️ Be open to feedback and constructive criticism during the review process. It's a collaborative journey!

  6. Testing:

    • 🧪 Include relevant tests for new features or bug fixes. Ensure your code survives the testing gauntlet!

  7. Documentation:

    • 📚 Update documentation for any changes. Let's keep our users in the know!
    • 📖 Provide clear and comprehensive README updates when necessary.

  8. Issues:

    • 🎯 Clearly define issues, including steps to reproduce for bugs. Use labels like a superhero!

  9. Collaboration:

    • 🤝 Coordinate with other contributors. Teamwork makes the dream work!
    • 💬 Discuss major changes or enhancements before unleashing your coding prowess.

  10. License Compliance:

    • 📜 Ensure that contributions comply with the project's license. No license rebels here!

  11. Be Respectful:

    • 🌈 Respect other contributors and maintain a positive and inclusive environment. Spread good vibes!
    • 🚫 Avoid offensive language. We're building bridges, not walls!

  12. Versioning:

    • 🚢 Follow semantic versioning for releases. Sail through releases with clear versioning!
    • 📣 Clearly state breaking changes, new features, and bug fixes in release notes.

  13. Code of Conduct:

    • 🤖 Abide by the project's code of conduct. Be the code superhero we need!
    • 🚨 Report any inappropriate behavior to the maintainers. Keep our space safe!

  14. Maintainer Responsibilities:

    • 🎩 Define the role and responsibilities of project maintainers. Hat's off to the maintainers!
    • 🕒 Ensure timely reviews and responses to contributors. Swiftly navigate the GitHub galaxy!

  15. Continuous Integration (CI):

    • ⚙️ Integrate CI tools to automatically run tests on pull requests. Let the robots do the heavy lifting!