Skip to content

Latest commit

 

History

History
45 lines (31 loc) · 1.82 KB

CONTRIBUTING.md

File metadata and controls

45 lines (31 loc) · 1.82 KB

Contributing

The following guidelines for contribution should be followed if you want to submit a pull request.

1. Fork the repository

2. Clone your new repository:

$ git clone https://github.com/<your-github-username>/queue.git

3. Set up the development environment with Docker:

$ make install

4. Add tests for your change. Make your change. Make the tests pass:

$ make test

5. Push to your fork and submit a pull request

At this point you're waiting on us. We may suggest some changes or improvements or alternatives.

Commit Messages

Please also write a good commit message:

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally
  • Consider starting the commit message with an applicable emoji:
    • 🎨 :art: when improving the format/structure of the code
    • 🐎 :racehorse: when improving performance
    • 🚱 :non-potable_water: when plugging memory leaks
    • 📝 :memo: when writing docs
    • 🐛 :bug: when fixing a bug
    • 🔥 :fire: when removing code or files
    • 💚 :green_heart: when fixing the CI build
    • :white_check_mark: when adding tests
    • 🔒 :lock: when dealing with security
    • ⬆️ :arrow_up: when upgrading dependencies
    • ⬇️ :arrow_down: when downgrading dependencies
    • 👕 :shirt: when removing linter warnings

Thanks to atom/atom for the commit message guidelines.