Skip to content

Latest commit

 

History

History
47 lines (32 loc) · 1.02 KB

CONTRIBUTING.md

File metadata and controls

47 lines (32 loc) · 1.02 KB

Storyscript contribution guidelines

You are welcome to contribute to Storyscript.

Contributions flow

Open an issue describing the changes, the benefits and eventual cons, so that the changes can be discussed, approved and assigned to someone.

If you are assigned to an issue, fork the repo and create a branch on your fork. When you are done, submit a pull request.

Opened issues

If you wish to work on an open, unassigned issue, please ask to be assigned to it in the issue.

Style guide

Follow pep8. A tox environment is provided

tox -e pep8

Commits

Ensure that changes pass all unit tests before pushing and that new features are covered by tests.

Commits messages

Please use an Angular-like style for commits messages.

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

Subject

The subject should contains succinct description of the change:

  • use the imperative, present tense: "change" not "changed" nor "changes"
  • don't capitalize first letter
  • no dot (.) at the end