Skip to content

Latest commit

 

History

History
79 lines (58 loc) · 3.06 KB

CONTRIBUTING.markdown

File metadata and controls

79 lines (58 loc) · 3.06 KB
Raw

How to Contribute to blacklight

Hi, and thanks for your interest in blacklight! We (royal we at this time) look forward to your contributions!

Getting Started

to contribute to blacklight you'll need...

  • A GitHub account
  • A Trello account to participate in the the Trello Board
  • Git
  • Go
  • The latest blacklight released for your platform
  • The latest blacklight repo
  • It'd also be super great if you sent me an email just to say hi and that you agree to the Contributor's Agreement (at the bottom)

If You Want to Assist

  1. Check out the Trello Board and GitHub Issues to see what there is to do
  2. Pick out a task from the Ready list on Trello or a Bug tag from Issues
  3. Fork the blacklight repo and start getting familiar with the codebase
  4. Make your changes (see Git Commit Messages and Code Standards sections later in this document)
  5. Run the examples to make sure you didn't break anything
  6. Open a Pull Request

Also, feel free to email me through GitHub (people do it all the time) or post an issue if you need help.

If You Have An Idea

  1. As above, check the Trello Board and GitHub Issues
  2. See if there's an existing or similar idea
  3. If so, feel free to start working on a solution (see above section), or wait for someone else to pick it up
  4. If not, submit it as a GitHub issue

To Report a Bug

Just use GitHub Issues and provide as much as possible of the following...

  1. The version of git SHA1 of blacklight that you're using
  2. An example script to reproduce the problem
  3. A clear description of what you expected to happen
  4. Detailed information about what happened instead
  5. Include the full text of error messages
  6. Your OS and its release info (ie Debian Jesse or Windows 8.1)

Git Commit Messages

  • Stick to GitHub's suggested commit message length
  • Keep commits small, you don't need to squash commits
  • Write informative summary of why your made your changes
  • Try to keep each commit in a working state
  • Use git add -p to chunk up your changes into logical units if you make several unrelated changes

Code Standards

  • Use go fmt (there are plugins for many editors which do this automatically)
  • Internal interfaces are lowercase
  • blacklight datatypes are uppercase

Contributor Agreement

You implicitly agree to this contributor agreement when contributing.

You grant me (Anthony M. Cook) a non-exclusive unlimited license to use your contributions. As well as granting a non-exclusive unlimited license to any patents you hold that you utitlize in your contribution.

You also grant permission for me (Anthony M. Cook) to change the license(s) of blacklight at any time without notice. Considering I haven't issued a license yet, this is doubly important.