Skip to content
This repository has been archived by the owner on Oct 14, 2020. It is now read-only.

Latest commit

 

History

History
70 lines (46 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

70 lines (46 loc) · 2.6 KB

Contributing

GitHub Flow

For more information see GitHub Flow

GitHub Flow is very lightweight (especially compared to GitFlow). This workflow uses only two kinds of branches:

  • Feature branch
  • Main branch (previously called master)

The feature branches are used to develop new features as well as fixes. These branches are usually created out of main.

Anything in the main branch is deployable. The main branch is expected to be deployed regularly and is considered stable.

How to work with GitHub Flow

For more information see GitHub Flow

TL;DR

  1. anything in the main branch is deployable
  2. create descriptive branches off of main
  3. push to named branches constantly
  4. open a pull request at any time
  5. merge only after pull request review
  6. deploy immediately after review

Working with Forks and Pull Requests

Our current continuous integration workflow makes it very hard to work on own forks of the secureCodeBox because CI tests cannot be executed outside of our repository. We are aware of that problem and are working on a solution.

Generally the secureCodeBox project follows the standard GitHub Pull request process.

Working with Issues/How to Contribute in Issues

It is mandatory to open an issue, if the task takes longer than one hour. Before you open an issue please verify there is no existing one covering your issue.

How to Write Commit Messages

For more information see here.

TL;DR

  1. Separate subject from body with a blank line
  2. Limit the subject line to 50 characters
  3. Capitalize the subject line
  4. Do not end the subject line with a period
  5. Use the imperative mood in the subject line
  6. Wrap the body at 72 characters
  7. Use the body to explain what and why vs. how

NOTE: Make sure you don't include @mentions or fixes keywords in your git commit messages. These should be included in the PR body instead.

Code of Conduct

Please have a look at our Code of Conduct before you write an Issue or make a PR.