pydanny / refry

Refry is a modern, maintained, typed easy-to-use retry decorator.
BSD 3-Clause "New" or "Revised" License
22 stars 1 forks source link

📝 Update `CONTRIBUTING.md` with detailed contribution guidelines #37

Closed rjvitorino closed 4 months ago

rjvitorino commented 5 months ago

Summary of Changes:

This pull request enhances the CONTRIBUTING.md file by adding comprehensive guidelines for contributing to the project. These guidelines are designed to help new and existing contributors understand the contribution process and adhere to project standards.

Changes Include:

  1. Contribution Steps:

    • Detailed steps on how to start contributing.
    • Links to the project's Code of Conduct.
    • Instructions on reporting issues, suggesting enhancements, and submitting pull requests.
  2. Guidelines for Commit Messages:

    • Best practices for writing clear and concise commit messages.
  3. Pull Request Checklist:

    • A checklist to ensure all necessary steps are taken before submitting a pull request.
  4. Review Process:

    • Explanation of the review process to set contributor expectations.
  5. Coding Standards:

    • Links to coding standards and best practices to ensure code consistency.

Motivation and Context:

This update aims to provide clear and structured guidelines to streamline the contribution process. By offering detailed instructions and standards, we can improve collaboration and maintain high-quality contributions.

How to Review:

Related Issue:

This pull request addresses and closes issue #36.

Thank you for considering this enhancement to our contribution process. Your feedback is appreciated!

pydanny commented 4 months ago

Apologies, just saw this.