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

Latest commit

 

History

History
47 lines (27 loc) · 2.91 KB

CONTRIBUTING.md

File metadata and controls

47 lines (27 loc) · 2.91 KB
Raw

How to contribute

If you're reading this, it means you saw something that is not right, you want to add a new feature or your manager asked you to contribute to this. In any case we are glad and it would be awesome if you can contribute.

Testing

We have a handful of unit tests. In our Git workflow unit tests are run on every Push and Pull Request.

Submitting Issues

We have templates for submitting new issues, that you can fill out. For example if you found a bug, use the following template to report a bug.

Submitting changes

When you made some changes you are happy with please send a GitHub Pull Request to beacon-network to dev branch with a clear list of what you've done (read more about pull requests). When you create that Pull Request, we will forever be in your debt if you include unit tests. For extra bonus points you can always use add some more integration tests.

Please follow our Git branches model and coding conventions (both below), and make sure all of your commits are atomic (preferably one feature per commit) and it is recommended a Pull Request addresses one functionality or fixes one bug.

Always write a clear log message for your commits, and if there is an issue open, reference that issue. This guide might help: How to Write a Git Commit Message.

Once submitted, the Pull Request will go through a review process, meaning we will judge your code 😄.

Git Branches

We use dev branch as the main development branch and master as the releases branch. All Pull Requests related to features should be done agains dev branch, releases Pull Requests should be done agains master branch.

Give your branch a short descriptive name (like the names between the <> below) and prefix the name with something representative for that branch:

  • feature/<feature-name> - used when an enhancement or new feature was implemented;
  • docs/<what-the-docs> - missing docs or keeping them up to date;
  • bugfix/<caught-it> - solved a bug;
  • test/<thank-you> - adding missing tests for a feature, we would prefer they would come with the feature but still thank you;
  • refactor/<that-name-is-confusing> - well we hope we don't mess anything and we don't get to use this;
  • hotfix/<oh-no> - for when things needed to be fixed yesterday.

Coding conventions

We do optimize for readability, and it would be awesome if you go through the code and see what conventions we used so far:

  • We follow pep8 and pep257 with some small exceptions;
  • We like to keep things simple, so when possible avoid importing any big libraries.

Thanks, CSC Developers