Skip to content

Contribution Guidelines

abel barbosa edited this page Jul 28, 2024 · 2 revisions

a) How to contribute:

  1. Expertise Requirement: Contributors must have demonstrable experience and expertise in the relevant technology stack and programming languages used in the project.
  2. Code Quality: Only those who can adhere to the highest standards of code quality, including comprehensive documentation and adherence to coding guidelines, should contribute.
  3. Issue Handling: Contributors should have a proven track record of efficiently identifying, addressing, and resolving issues within open-source projects.
  4. Testing Proficiency: Ensure contributors can write thorough unit tests and understand continuous integration practices to maintain the project's stability.
  5. Collaboration Skills: Potential contributors should exhibit strong communication and teamwork skills, as collaboration is key to successful open-source projects.

b) Issue reporting:

  1. Be Clear and Specific
    Title: Give a clear and descriptive title to your issue.
    Description: Provide a detailed description of the problem. Explain what you were trying to do, what you expected to happen, and what actually happened.
  2. Include Steps to Reproduce
    Reproduction Steps: List the steps someone else needs to follow to reproduce the issue. This might include code snippets, commands, or specific actions.
    Environment Details: Mention the environment in which the issue occurs, including the operating system, version of the minute_timer library, and any other relevant dependencies.
  3. Provide Logs and Screenshots
    Logs: Include any relevant logs or error messages. This helps the maintainers understand what went wrong.
    Screenshots: If applicable, add screenshots to illustrate the issue. Visual aids can often make the problem clearer.
  4. Suggest Possible Solutions
    Initial Thoughts: If you have any idea about what might be causing the issue or potential fixes, mention them. This can save the maintainers time and guide them in the right direction.
    Prior Research: Indicate any steps you've already taken to try to resolve the issue on your own. Mention if you've checked existing issues, documentation, or other resources.
  5. Be Polite and Patient
    Polite Language: Use courteous and respectful language. Remember that maintainers are often volunteers or busy professionals.
    Patience: Understand that it might take time for the maintainers to respond and address your issue. Avoid repeated follow-ups or demands for an immediate fix.

Clone this wiki locally