There are many ways to contribute to this little project and all those ways are equally welcome!
If you encounter a bug in go-week please file a short report with a description of the bug in
the issue tracker and label it as bug. Before doing so,
please check if the same bug was already reported. In that case just add your information to the
existing issue.
If you desire additional functionality which is not yet provided by the package, please enter a feature
request to the issue tracker and label it as enhancement.
If you would like to contribute code and/or documentation directly, you are very welcome to open a pull request with your contributions.
The following steps outline the workflow for code contributions:
- All pull request should be linked to an existing issue in the issue tracker. Before you star to work on your code, please communicate your interest to work on the respective issue.
- Fork the repository.
- Write your code and commit the changes to your fork.
- Open a new pull request. The pull request description should contain a summary of the changes and a reference to the respective issue in the issue tracker.
- Your pull request will be reviewed, and finally, if everything looks good, merged into master.
The project adheres to common Go code style conventions. Code must be formatted with gofmt or a compatible
tool, and must pass linting via golint. In doubt just read through the existing code base to figure out
code and naming conventions used in this project.
Happy hacking!