Skip to content
This repository has been archived by the owner on Feb 4, 2020. It is now read-only.

Latest commit

 

History

History
43 lines (29 loc) · 1.93 KB

CONTRIBUTING.md

File metadata and controls

43 lines (29 loc) · 1.93 KB
Raw

Contributing

Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

Issues and PRs

If you have suggestions for how this project could be improved, or want to report a bug, open an issue! We'd love all and any contributions. If you have questions, too, we'd love to hear them.

We'd also love PRs. If you're thinking of a large PR, we advise opening up an issue first to talk about it, though! Look at the links below if you're not sure how to open a PR.

Submitting a pull request

  1. Fork and clone the repository.
  2. Configure and install the dependencies: npm install.
  3. Make sure the tests pass on your machine: npm test, note: these tests also apply the linter, so there's no need to lint separately.
  4. Create a new branch: git checkout -b my-branch-name.
  5. Make your change, add tests, and make sure the tests still pass.
  6. Commit your changes with message conforming to the Git Commit Messages guidelines.
  7. Push to your fork and submit a pull request.
  8. Pat your self on the back and wait for your pull request to be reviewed and merged.

Work in Progress pull requests are also welcome to get feedback early on, or if there is something blocking you.

Git Commit Messages

  1. Write a descriptive commit message
  2. Use the present tense ("Add feature" not "Added feature")
  3. Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  4. If you are fixing a GitHub issue, include something like 'Closes issue #xyz'
  5. For more best practices, read How to Write a Git Commit Message

Contacts

In case of any question, contact us on the freenode.net IRC channel #leapp, or write the question as an issue on GitHub.

Resources