Skip to content

Latest commit

 

History

History
31 lines (21 loc) · 1.74 KB

CONTRIBUTING.md

File metadata and controls

31 lines (21 loc) · 1.74 KB

Contributing

Hi there! We're thrilled that you'd like to contribute to our publisher-interface project. We definitely could use your help to keep this publisher-interface great.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Submitting a pull request

  1. Fork and clone this repository
  2. Create a new branch: git checkout -b my-branch-name *
  3. Make your change and remember to add tests
  4. Build the project locally and run local tests
  5. Push to your fork and submit a pull request
  6. Pat yourself on the back and wait for your pull request to be reviewed and get merged.

*replace my-branch-name with something specific. We use the prefixes fix and feature in our branches to indicate what they represent. An example for a branch that fixes a bug in playAnimation f.e. could be fix/play-animation-fixdescription

Acceptance criteria

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

  • Write tests.
  • Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, submit them as separate pull requests.
  • Write good commit messages.
  • Prefix the title with [Fix] or [Feature] to describe what the scope is

Resources