Skip to content

Latest commit

 

History

History
77 lines (55 loc) · 3.28 KB

CONTRIBUTING.md

File metadata and controls

77 lines (55 loc) · 3.28 KB
Raw

Contributing to this project

(We took some of this from Atom's GitHub as an starting point)

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for this project, which are hosted in the nullbucket organization (null0) on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Your First Code Contribution

Unsure where to begin contributing? You can start by looking through these beginner and help-wanted issues:

  • [Beginner issues][beginner] - issues which should only require a few lines of code, and a test or two.
  • [Help wanted issues][help-wanted] - issues which should be a bit more involved than beginner issues.

We have yest tried accepting forks but are open to it.

Pull Requests (We took some of this from Atom's GitHub as an example)

  • Fill in the required template
  • Do not include issue numbers in the PR title
  • Include screenshots and animated GIFs in your pull request whenever possible.
  • Document new code based on the Documentation Styleguide
  • End all files with a newline

QuickStart

Right now main contributers are within the project, using branches. We do prefer that pushes be pgp verified (signed).

This is an example of a simple session:

  1. Do your work on a local branch in Git like this:

    • git checkout -b mybranch
    • git status
    • git add -A
    • git status
    • git commit -m "comment w/github ref like #9"
    • git push -u origin mybranch

  2. Submit a pull request for your branch in GitHub

  3. The reviewer will merge your changes and probably delete your branch right away.

  4. After that happens, switch your local back to master and delete your branch:

    • git checkout master
    • git pull --rebase
    • git branch -d mybranch

Styleguides

Git Commit Messages (We took some of this from Atom's GitHub as an example)

  • 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 after the first line
  • When only changing documentation, include [ci skip] in the commit title
  • 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
    • 🐧 :penguin: when fixing something on Linux
    • 🍎 :apple: when fixing something on macOS
    • 🏁 :checkered_flag: when fixing something on Windows
    • 🐛 :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
    • for more examples, see https://gitmoji.carloscuesta.me/