Skip to content

Latest commit

 

History

History
103 lines (63 loc) · 3.93 KB

CONTRIBUTION.md

File metadata and controls

103 lines (63 loc) · 3.93 KB
Raw

Contribution Guidelines

Welcome Contributors! :octocat:

Thank you for considering contributing to our project. Your contributions are highly valued, and this guide is designed to ensure a smooth and collaborative experience for everyone involved. By following these guidelines, we aim to create a positive and inclusive space for all contributors and maintainers.

🪲 Bug Reports and Issue Submissions

Reporting bugs or submitting detailed issues is a valuable way to contribute to the project. We appreciate well-written bug reports that include thorough information. To ensure a productive conversation, please adhere to the following:

Guidelines:

  1. Provide a clear and detailed description of the issue.
  2. Utilize the issue template provided to include all necessary information.
  3. Avoid opening duplicate issues; check for existing reports first and comment on those if applicable.

💌 Feature Requests

We welcome feature requests! While we consider all suggestions, acceptance is not guaranteed. To avoid feature creep, please follow these guidelines:

Guidelines:

  1. Check for existing feature requests before submitting a new one.
  2. Fully complete the provided feature request template, providing comprehensive information.
  3. Be precise about the proposed outcome and its relation to existing features.
  4. Include implementation details if possible.

🔍 Triaging Issues

Contributors can assist in triaging issues, such as reproducing bug reports or requesting additional information. Any help in quickly resolving issues is highly appreciated.

🔁 Submitting Pull Requests

We love pull requests! Before creating a pull request, it's advisable to open an issue to discuss changes or outline your intended approach. Please adhere to the following guidelines for a seamless contribution process:

Guidelines:

  1. Submit one pull request per bug fix or feature to keep changes isolated.
  2. For larger changes, discuss strategies with maintainers by opening an issue.
  3. Prioritize code clarity over complexity and follow existing coding styles and conventions.
  4. Update the example project if applicable to demonstrate new functionality.
  5. Use the default branch for your pull request and resolve any merge conflicts.
  6. Promptly address any CI failures.

📝 Writing Commit Messages

Crafting meaningful commit messages is crucial. Follow these guidelines to ensure clear communication:

Guidelines:

  1. Separate subject from body with a blank line.
  2. Limit the subject line to 50 characters and use the imperative mood.
  3. Use the body to explain why, not what and how.
  4. Wrap the body at about 72 characters.
  5. If applicable, prefix the title with the relevant component name.

✅ Code Review

Effective code reviews are essential. Provide constructive feedback without criticizing the author personally. Remember:

Guidelines:

  1. Review the code, not the author.
  2. Understand that you are not your code.
  3. Always strive to do your best and learn from mistakes.
  4. Note any violations of guidelines specified in this document.

💅 Coding Style

Consistency is key. Follow existing styles, formatting, and naming conventions of the project. Failure to do so may result in a prolonged review process.

Guidelines:

  1. Maintain consistency with the existing codebase.
  2. Follow style and format conventions, enforced by a linter when possible.

Conclusion

Thank you for considering contributing to our project! Here's a summary of the contribution process:

  1. Work on non-assigned issues once assigned or raise an issue to get it assigned.
  2. Make changes in the code without introducing bugs.
  3. Refactor and enhancements are appreciated.
  4. Raise a PR and tag @anand-harsh for review.
  5. Make PR directly on the master branch of Edumi.

If you're reading this, congratulations on being an awesome contributor! Your efforts are truly appreciated. 💯