Skip to content

Latest commit

 

History

History
113 lines (86 loc) · 4.87 KB

CONTRIBUTING.md

File metadata and controls

113 lines (86 loc) · 4.87 KB
Raw

How to contribute

(adapted from the Puppet Jira project's CONTRIBUTIONS.md)

There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.

Getting Started

  • Make sure you have a GitHub account.
  • Submit a ticket for your issue, assuming one does not already exist.
    • Clearly describe the issue including steps to reproduce when it is a bug.
    • Make sure you fill in the earliest version that you know has the issue.
  • 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.
    • To quickly create a topic branch based on master, run git checkout -b fix/master/my_contribution master. Please avoid working directly on the master branch.

  • Make commits of logical units.

  • Check for unnecessary whitespace with git diff --check before committing.

  • Make sure your commit messages are in the proper format. If the commit addresses an issue filed in the ch554_sdcc Issues, start the first line of the commit with the issue number in parentheses.

        (PUP-1234) Make the example in CONTRIBUTING imperative and concrete

    Without this patch applied the example commit message in the CONTRIBUTING
    document is not a concrete example. This is a problem because the
    contributor is left to imagine what the commit message should look like
    based on a description rather than an example. This patch fixes the
    problem by making the example concrete and imperative.

    The first line is a real-life imperative statement with a ticket number
    from our issue tracker. The body describes the behavior without the patch,
    why this is a problem, and how the patch fixes the problem when applied.

  • Make sure you have added the necessary tests for your changes.

  • Run all the tests to assure nothing else was accidentally broken. See the 'Getting Started' section of README.md for up-to-date information on testing. Additionally, the tests will also be run automatically by Travis CI, once a pull request is submitted.

Making Trivial Changes

Documentation

For changes of a trivial nature to comments and documentation, it is not always necessary to create a new issue in Github issues. In this case, it is appropriate to start the first line of a commit with (docs) instead of an issue number.

If a Github issue exists for the documentation commit, you can include it after the (docs) token.

    (docs)(DOCUMENT-000) Add docs commit example to CONTRIBUTING

    There is no example for contributing a documentation commit
    to the Puppet repository. This is a problem because the contributor
    is left to assume how a commit of this nature may appear.

    The first line is a real-life imperative statement with '(docs)' in
    place of what would have been the PUP project ticket number in a
    non-documentation related commit. The body describes the nature of
    the new documentation or comments added.

For commits that address trivial repository maintenance tasks, start the first line of the commit with (maint).

Submitting Changes

  • Push your changes to a topic branch in your fork of the repository.
  • Submit a pull request to the repository in the Blinkinlabs organization.
  • The core team looks at Pull Requests on a regular basis.
  • After feedback has been given we expect responses within two weeks. After two weeks we may close the pull request if it isn't showing any activity.

Revert Policy

By running tests in advance and by engaging with peer review for prospective changes, your contributions have a high probability of becoming long lived parts of the the project. After being merged, the code will run through a series of testing pipelines on a large number of operating system environments. These pipelines can reveal incompatibilities that are difficult to detect in advance.

If the code change results in a test failure, we will make our best effort to correct the error. If a fix cannot be determined and committed within 24 hours of its discovery, the commit(s) responsible may be reverted, at the discretion of the committer and Puppet maintainers. This action would be taken to help maintain passing states in our testing pipelines.

The original contributor will be notified of the revert in the Github issue associated with the change. A reference to the test(s) and operating system(s) that failed as a result of the code change will also be added to the Github issue. This test(s) should be used to check future submissions of the code to ensure the issue has been resolved.

Summary

  • Changes resulting in test pipeline failures will be reverted if they cannot be resolved within one business day.

Additional Resources