Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
100 lines (63 loc) · 5.4 KB

CONTRIBUTING.md

File metadata and controls

100 lines (63 loc) · 5.4 KB

Contributing Guidelines

Interested in making a contribution? Great! Just read through this guide and you should be good to go! If you have any questions or concerns, feel free to reach out to us in our Slack community channel.

TOC

Forks

We encourage the use of forks, even for our core maintainers. The following steps describe the procedure to create a new fork and contribute back to the upstream repo:

  1. Fork https://github.com/3blades/notebook-servers repository to your user organization.
  2. Clone your copy of https://github.com/your-username/notebook-servers onto your machine using git clone https://github.com/your-username/notebook-servers.
  3. Specify a new remote upstream repository that will be synced with the fork: git remote add upstream https://github.com/3blades/notebook-servers.
  4. Verify correct upstream configuration: git remote -v
  5. Fetch the branches and their respective commits from the upstream repository. Commits to master will be stored in a local branch, upstream/master.
  6. Checkout your fork's local feature or fix branch: git checkout my-fix-or-feature-branch.
  7. Make the necessary changes in your my-fix-or-feature-branch branch. .
  8. Merge the changes from your local my-fix-or-feature-branch branch with upstream/master, ensuring that your local changes are in sync with upstream master branch: git merge upstream/master.
  9. Submit a pull request to https://github.com/3blades/notebook-servers and await review.

Commit Messages

Commit messages in notebook-servers start with a prefix that coincides with an issue label, then /, then iss[#], such as fix/iss3. It's possible that an issue for the problem you are trying to solve does not exist, in that case, please help us open one. Even little things like typos in a document are worth documenting. Labels listed below:

  • fix: If the commit is working towards a bug fix.
  • feature: If the commit is working towards a new feature.
  • chore: If the commit was a chore, like updating a dependency or updating Travis.
  • doc: If the commit is a change to documentation.
  • test: If the commit contains a change to the test suite.

Issues

When reporting issues:

  • Include the steps required to reproduce the problem. This information will help us review and fix your issue faster.
  • If applicable, include stack trace.
  • Big log files are best viewed in gist (https://gist.github.com). Make sure your gist is public.
  • Log files may have sensitive information, please remove this information if at all possible.

Quick contribution tips and guidelines

This section gives contributors some guidelines.

We welcome all pull requests

Developing a fix or new feature, however small, takes time. So thank you! Even the smallest corrections or enhancements matter, and we will do everything possible to process them in a timely manner. We will also make sure you get credit for your contributions.

Design and cleanup proposals

We are constantly cleaning code and re factoring, and understand there is almost always a better way to do things. If so, let us know! We love new perspectives, particularly when it helps improve the underlying product.

Talking to other 3Blades users and contributors

We primarily use our Slack community channel to communicate with 3Blades users and contributors. You can sign up for a free account here.

Conventions and Coding Style

Submit unit tests with your changes. We primarily use nosetests for Python, jest for React and testing for Golang.

Update the documentation when creating or modifying features. Test your documentation changes for clarity, concision, and correctness, as well as a clean documentation build. We base our style guide on the AP Stylebook.

For coding style, we base ourselves on:

The PR should trigger automated style checks.

Merge approval

The master branch needs to be as healthy as possible. We will do our best to merge code and documentation quickly, but need to balance that with sanity checks.

Maintainers may use LGTM (Looks Good To Me) for documents and comments to indicate acceptance.

Sign your work

Our projects are open source and we need to do everything possible to keep it that way. By signing, you certify that you wrote the code or that you have the right to send it our way. We use the developer certificate of origin text to certify contributions.

Every completed PR must have a signature before we can merge:

Signed-off-by: Joe Smith <joe.smith@email.com>

Please use your real name.

If you set your user.name and user.email git configs, you can sign your commit automatically with git commit -s.

3Blades community guidelines

Refer to our Code of Conduct for specifics. It is based on the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4.