Skip to main content
Version: 4.x

Contribution Guide

Introduction​

Contributions are welcome and will be fully credited. If you want to contribute to the project, please first discuss the changes you want to make via email, by creating an issue on GitHub, with the repository maintainers before coding your solution.

Please make sure to comply with the code of conduct during your interactions on this project.

We accept contributions via Pull Request on GitHub.

Contribution process​

  • Fork the project
  • Create a branch with a name that describes your changes
  • Use descriptive commit messages
  • Add unit tests
  • Document your changes - Make sure the documentation is updated to reflect your changes
  • One pull request per feature - If you want to do more than one thing, make several pull requests
  • Update the version - We follow the SemVer scheme

Commit message format​

To make maintaining the repository easier, Bow uses a format for commit messages.

  • change to add a change to a behavior
  • fix to fix a bug
  • feat to add a new feature

Please refer to the following example:

git commit

In your editor

change(module_name): your commit message

Description

If the change affects a section:

git commit -m "change(session): rename init variable"

If the change affects an element within a section:

git commit -m "fix(http:request): bug fix #40"

In case your changes affect multiple sections, add a description with your commit as a bullet list.

Note that commit messages must be in English.

Is something missing?

If you run into problems with the documentation or have suggestions to improve the documentation or the project in general, please open an issue for us, or send a tweet mentioning the Twitter account @bowframework or directly on github.