Contribution Guidelines

Contribution Guidelines

• Got a question or a problem?
• Found an issue?
• Want a feature?
• Submission guidelines
  • Submitting an issue
  • Submitting a pull request
    • After your pull request is merged
• Coding rules

We'd love for you to contribute to BEURK, and make it even better than it is today. Here are the guidelines we'd like you to follow.

Got a question or a problem?

If you have any questions about BEURK, please direct those to the project's Gitter Channel.

Found an Issue?

If you find a bug in the source code or a mistake in the documentation, you can help us by submitting an issue to our GitHub Repository. Even better, you can submit a Pull Request with a fix.

Please see the Submission Guidelines below.

Want a Feature?

You can request a new feature by submitting an issue to our GitHub Repository.

If you would like to implement a new feature, they can be submitted as a Pull Request.

See Using Pull Requests

Submission Guidelines

Submitting an Issue

Before submitting your issue, search the archive, your question may already be answered.

If your issue appears to be a bug, and hasn't been reported, open a new issue.

Help us maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues.

Providing the following information will increase the chances of your issue being dealt with quickly:

• Title - a short description of the issue.
• Labels - add the correct Issue Labels.
• Motivation for or Use Case - explain why this is a bug for you.
• Impacted Version(s) - is it a regression?
• Target and/or attacker system - is this a problem with all GNU/Linux distributions or a located one?
• Reproduce the Error - provide a set of steps leading to the error.
• Related Issues - has a similar issue been reported before ?
• Suggest a Fix - if you can't fix the bug yourself, perhaps you can point to what might be causing the problem (line of code or commit)

If you get help, help others. Good karma rulez!

Submitting a pull request

Before you submit your pull request, consider the following guidelines:

• Search for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort.

• Make your changes in a new Feature Branch:

    git checkout -b my-feature-branch master

• Create your patch, including appropriate test cases.

• Follow our Coding Rules.

• Run the full BEURK Test Suite, ensuring that all tests are still passing.

• Commit your changes using a descriptive commit message that passes our commit presubmit hook. Adherence to our Commit Conventions is required because release notes are automatically generated from these messages.

    git commit -a

  Note: the optional commit -a command line option will automatically add and rm edited files.

• Push your branch to GitHub:

    git push origin my-feature-branch

• In GitHub, send a pull request to BEURK:master.

• If we suggest changes then:

  • Make the required updates.
  • Re-run the BEURK Test Suite to ensure tests are still passing.
  • Rebase your branch and force push to your GitHub repository (this will update your Pull Request):

      git rebase master -i
      git push origin my-feature-branch -f

That's it! Thank you for your contribution!

After your pull request is merged

After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:

• Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:

    git push origin --delete my-feature-branch

• Check out the master branch:

    git checkout master -f

• Delete the local branch:

    git branch -D my-feature-branch

• Update your master with the latest upstream version:

    git pull --ff upstream master

Coding rules

To ensure consistency throughout the source code, please keep these rules in mind as you are working:

• All changes impacting usage must be documented in the [Wiki].

• Please be mindful of the existing coding style before contributing.

---