Skip to content

Latest commit

 

History

History
51 lines (37 loc) · 2.77 KB

CONTRIBUTING.md

File metadata and controls

51 lines (37 loc) · 2.77 KB

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Note we have a code of conduct. Please follow it in all your interactions with the project.

Where to start contributing

  • Look for issues marked "Good First Issue" in a repository's issue queue.
  • Look for issues that you could investigate and submit a pull request to fix.
  • Ask in the Emulsify Slack. Ping @amazingrando.

How to create an issue

  • Search the issue tracker and confirm that there is not already an issue.
  • Tell us the expected behavior and compare it with the current behavior.
  • Suggest a solution, if you have one.
  • For bugs, explain how to reproduce it.
  • Share your environment information, like repo version used, browser, OS, etc.

Full details are available in ISSUE_TEMPLATE.md

How to create a pull request

  • Search the pull requests (PR) and confirm that there is not already a PR posted that fixes the same issue.
  • Provide a summary of what the PR fixes or implements and the motivation for the change. ** If your PR is large or complex, consider posting an issue to discuss what you would like to contribute.
  • Provide corresponding documentation changes, if needed.
  • Write out step-by-step instructions for reviewing the PR.
  • If the PR closes any issue, add a "closes #XXX" comment to auto close the issue when the PR gets merged.

Full details are available in PULL_REQUEST_TEMPLATE.md

The project board

The Emulsify organization is project managed in Github in the Emulsify Project board

Label guide

  • "Bug" - use this to label an issue or pull request when something is broken or working wrong.
  • "Enhancement" - use this to label an issue or pull request as a new feature or feature enhancement.
  • "Good First Issue" – use this to mark an issue or pull request as something easy for folks to contribute to.
  • "Needs Work" - use when a pull request has been reviewed and changes are requested.
  • "On Hold" - use when a pull request is blocked or work is paused.
  • "Passes Code Review" - use when a pull request passes code review.
  • "Passes Functional Review" - use when a pull request passes a functional review.
  • "Question" - use when more information is needed for an issue or pull request
  • "Ready for Review" - use when a pull request is ready to be reviewed.
  • "Ready to Merge" - use when a pull request has been code and functionally reviewed and approved.
  • "Review in progress" - use this to let others know that a pull request is being reviewed
  • "Work in Progress" - use this when a pull request is still be worked on.