Skip to content

Latest commit

 

History

History
62 lines (45 loc) · 2.97 KB

contributing.md

File metadata and controls

62 lines (45 loc) · 2.97 KB
Raw

How to contribute

Third-party patches are essential for keeping NBi great. We want to keep it as easy as possible to contribute changes. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.

We love pull requests from everyone. By participating in this project, you agree to abide by the thoughtbot code of conduct.

Getting Started

  • Make sure you have a GitHub account (It's free!)
  • Read the documentation.
  • Search in the issues if your problem hasn't already be submitted.
  • Submit an issue (assuming one does not already exist).
    • Clearly describe the issue including steps to reproduce when it is a bug.
    • Specify the version on which this bug has been found.
  • Fork the repository on GitHub

Making Changes

  • Create a topic branch from where you want to base your work.
    • This is usually the master branch.
    • Only target release branches if you are certain your fix must be on that branch.
    • To quickly create a topic branch based on master; git checkout -b fix/master/my_contribution master. Please avoid working directly on the master branch.
    • The name of your branch should contain the issue number
  • Make commits of logical units.
  • Check for unnecessary whitespace with git diff --check before committing.
  • Make sure your commit messages is explicit.
  • Make sure you have added the necessary tests (acceptance, integration and/or unit) for your changes.
  • If possible, run all the tests to assure nothing else was accidentally broken.
  • Check the status of your build on appVeyor. If something is broken, try to fix it.

Making Trivial Changes

Documentation

For changes of a trivial nature to comments and documentation, it is not necessary to create an issue. In this case, it is appropriate to start the first line of a commit with '(doc)'.

Submitting Changes

  • Push your changes to a topic branch in your fork of the repository.
  • Submit a pull request to the repository NBi (Seddryck/NBi).
  • Update your issue to mark that you have submitted code and are ready for it to be reviewed (Status: ready-for-merge).
    • Include a link to the pull request in the ticket.
  • At this point, you're waiting on us. We like to, at least, comment on pull requests within a few business days. We may suggest some changes or improvements or alternatives.

Some things that will increase the chance that

Your issue will be quickly answered:

  • Write a good description of your problem in the issue ticket
    • If you've a problem using NBi, post your test (not a screen capture) and explain what you're trying to achieve. Don't forget to post the error (full stack) that you're receiving!
    • If you'd like to suggest a feature, explain why you think it will be valuable and suggest a syntax.

Your pull request is accepted:

  • Write a good description of your issue in the ticket
  • Write tests.