CONTRIBUTING.md

Contributing to Gitness

Thank you for your interest in contributing to the Gitness project. Gitnes uses GitHub to manage reviews of pull requests.

• If you are a new contributor see: Steps to Contribute

• If you have a minor fix or improvement, feel free to create a pull request. Please provide necessary details in the pull request description and use a meaningful title.

• If you plan to do something more involved, first discuss your ideas by raising an issue. This will avoid unnecessary work and surely give you and us a good deal of inspiration.

• Relevant coding style guidelines are

  • For backend: the Go Code Review Comments and the formatting and style section of Peter Bourgon's Go: Best Practices for Production Environments
  • For frontend: Google TypeScript Style Guide and Best practices for Typescript coding.

• Be sure to sign off on the CLA.

Steps to Contribute

Should you wish to work on an issue, please claim it first by commenting on the GitHub issue that you want to work on. This is to prevent duplicated efforts from contributors on the same issue.

Please check the good-first-issue label to find issues that are good for getting started. If you have questions about one of the issues, with or without the tag, please comment on them and one of the maintainers will clarify it. For a quicker response, contact us over slack or join our weekly office hours.

Local Development

Please review Gitness development to build and test your code locally.

Pre-commit Hook

We have a pre-commit hook to ensure code quality before committing changes. This hook checks for required binaries (grep, sed, and xargs) and runs checks specifically for Go files (*.go). If any issues are found during the checks, the commit process will be halted until the issues are resolved.

Lint Check

Our CI Linter pipeline conducts automated checks for code quality, with separate lint checks for Go and TypeScript. These checks help ensure adherence to coding standards and identify potential issues early in the development process. Thank you for contributing to our code quality efforts!

Pull Request Checklist

• Branch from the main branch and, if needed, rebase to the current main branch before submitting your pull request. If it doesn't merge cleanly with main you may be asked to rebase your changes.

• Commits should be as small as possible, while ensuring that each commit is correct independently (i.e., each commit should compile and pass tests).

• If your patch is not getting reviewed or you need a specific person to review it, you can @-reply a reviewer asking for a review in the pull request or a comment.

• Add tests relevant to the fixed bug or new feature.

Dependency management

The Gitness project uses Go modules to manage dependencies on external packages.

To add or update a new dependency, use the go get command:

# Pick the latest tagged release.
go get example.com/some/module/pkg@latest

# Pick a specific version.
go get example.com/some/module/pkg@vX.Y.Z

Tidy up the go.mod and go.sum files:

# The GO111MODULE variable can be omitted when the code isn't located in GOPATH.
GO111MODULE=on go mod tidy

You have to commit the changes to go.mod and go.sum before submitting the pull request.