Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
76 lines (45 loc) · 3.74 KB

CONTRIBUTING.md

File metadata and controls

76 lines (45 loc) · 3.74 KB

Welcome to CCSync 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 a contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

New contributor guide

To get an overview of the project, read the documentation of CCSync.

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

Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. If you find an issue to work on, and after discussion, it comes out to be a valid issue, you are welcome to open a PR with a fix.

Make Changes

  1. Fork the repository.

  1. For more information, see the development guide.

  2. Create a new working branch and start with your changes!

Commit your updates

Commit the changes once you are happy with them.

Please follow these rules or conventions while committing any new changes:

  • feat: new feature for the user, not a new feature for build script
  • fix: bug fix for the user
  • docs: changes to the documentation
  • style: formatting, missing semi colons, etc
  • refactor: refactoring production code, eg. renaming a variable
  • test: adding missing tests, refactoring tests
  • chore: updating grunt tasks, etc., no production code change

Note: This project uses Git pre-commit hooks to automatically format code before committing.

The hooks are set up automatically when you run npm install in the frontend directory. When you commit changes:

  • Frontend files (JS/TS/JSON/CSS/MD) will be automatically formatted with Prettier
  • Backend Go files will be automatically formatted with gofmt (if Go is installed)

If you need to manually format files:

  • Run npm run pre-commit for frontend formatting (from frontend directory)
  • Run gofmt -w . for backend formatting

Pull Request

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

  • Don't forget to link PR to issue if you are solving one.
  • Enable the checkbox to allow maintainer edits so the branch can be updated for a merge.
  • 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 🎉🎉.

Once your PR is merged, your contributions will be publicly visible in closed PRs.