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

Latest commit

 

History

History
93 lines (60 loc) · 2.78 KB

CONTRIBUTING.md

File metadata and controls

93 lines (60 loc) · 2.78 KB

Welcome to Chloe contributing guide

Thank you for investing your time in contributing to our project!

Read our Code of Conduct to keep our community approachable and respectable.

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

Getting started

Issues

Create a new issue

If you spot a problem with the docs, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.

Solve an issue

Make Changes

Make changes locally

  1. Fork the repository.

  2. Install or update Golang

  3. Create a working branch and start with your changes!

Commit your update

Commit the changes once you are happy with them.

Linting (optional)

We use pre-commit to lint and format our code.

Installing it is optional, as the CI will run the linters for you, but it's recommended to install it locally.

You can install it by running:

pip install pre-commit

or

brew install pre-commit

Then run:

pre-commit install

This will install the pre-commit hook in your local repository. Now, every time you commit, the pre-commit hook will run and check your code for linting and formatting errors.

If it fails with the following error:

- hook id: end-of-file-fixer
- exit code: 1
- files were modified by this hook

Just run git add -A and commit again.

Pull Request

When you're finished with the changes, create a pull request, also known as a PR.

  • Fill the required fields in the PR template.
  • Don't forget to link PR to issue if you are solving one.
  • We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
  • As you update your PR and apply changes, mark each conversation as resolved.
  • If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

Your PR is merged

Congratulations 🎉🎉 The Chloe team thanks you ✨.