Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
44 lines (36 loc) · 2.45 KB

CONTRIBUTING.md

File metadata and controls

44 lines (36 loc) · 2.45 KB
Raw

Contributing to Monocle

Contributions to Monocle are welcome from everyone. The following are a set of guidelines for contributing to Monocle. Following these guidelines makes contributing to this project easy and transparent. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. Please refer to our code of conduct when making contributions.

How can you contribute?

Contributing code

If you encounter a bug, you can

  • (Recommended) File an issue about the bug.
  • Provide clear and concrete ways/scripts to reproduce the bug.
  • Provide possible solutions for the bug.
  • Pull a request to fix the bug.

If you're interested in existing issues, you can

  • (Recommended) Provide answers for issue labeled question.
  • Provide help for issues labeled bug, improvement, and enhancement by -- (Recommended) Ask questions, reproduce the issue, or provide solutions. -- Pull a request to fix the issue.

If you require a new feature or major enhancement, you can

  • (Recommended) File an issue about the feature/enhancement with reasons.
  • Pull a request to implement the feature.

If you are submitting a pull request in Monocle

  • Fork Monocle repo into your personal/org git organisation
  • Sync the repo with latest on Monocle main before you start making code changes.
  • Create a separate branch in your fork for the pull request off the main.
  • If this is a code changes, then add a test cases that validates the changes.
  • Every commit in your branch needs to be signed (git commit -s ...)
  • Create a Github pull request
  • Link to the tracking issue if there's one created
  • Complete the pull request template
  • Mentions any community members/maintainers to review your RP
  • Collaborate with the reviewer
    • Respond to questions/feedback on the PR.

If you are a reviewer/approver of Monocle, you can

  • Participate in PR review process.
    • Ask questions, provide feedback
  • At the end of satisfactory review process, merge the PR
  • Instruct newcomers in the community to complete the PR process.

If you want to become a contributor of Monocle, submit your pull requests. All contributions to this project must be accompanied by acknowledgment of, and agreement to, the Developer Certificate of Origin. All submissions will be reviewed as quickly as possible. Please refer to Monocle Contributor Guide for more details.