Skip to content

Latest commit

 

History

History
59 lines (41 loc) · 3.38 KB

CONTRIBUTING.md

File metadata and controls

59 lines (41 loc) · 3.38 KB
Raw

Contributing

Thank you for taking the time to contribute to sif! All contributions are valued, and no contribution is too small or insignificant. If you want to contribute but don't know where to start, worry not; there is no shortage of things to do.
Even if you don't know any Go, don't let that stop you from trying to contribute! We're here to help.

By contributing to this repository, you agree to adhere to the sif Code of Conduct. Not doing so may result in a ban.

How can I help?

Here are some ways to get started:

If you like the project, but don't have time to contribute, that's okay too! Here are other ways to show your appreciation for the project:

  • Use sif (seriously, that's enough)
  • Star the repository
  • Share sif with your friends
  • Support us on Liberapay (thank you!)

Reporting issues

If you believe you've found a bug, or you have a new feature to request, please hop on the Discord server first to discuss it.
This way, if it's an easy fix, we could help you solve it more quickly, and if it's a feature request we could workshop it together into something more mature.

When opening an issue, please use the search tool and make sure that the issue has not been discussed before. In the case of a bug report, run sif with the -d/-debug flag for full debug logs.

Contributing code

Development

To develop sif, you'll need version 1.20 or later of the Go toolchain. After making your changes, run the program using go run ./cmd/sif to make sure it compiles and runs properly.

Nix users: the repository provides a flake that can be used to develop and run sif. Use nix run, nix develop, nix build, etc. Make sure to run gomod2nix if go.mod is changed.

Submitting a pull request

When making a pull request, please adhere to the following conventions:

  • sif adheres to the Go style guidelines. Always format your gode with gofmt.
  • When adding/removing imports, make sure to use go mod tidy, and then run gomod2nix to generate the Nix-readable module list.
  • Set git config pull.rebase true to rebase commits on pull instead of creating ugly merge commits.
  • Title your commits in present tense, in the imperative style.
    • You may use prefixes like feat, fix, chore, deps, etc.
      Example: deps: update gopkg.in/yaml.v3 to v3.0.1
    • You may use prefixes to denote the part of the code changed in the commit.
      Example: pkg/scan: ignore 3xx redirects
    • If not using a prefix, make sure to use sentence case.
      Example: Add nuclei template parsing support
    • If applicable, provide a helpful commit description, listing usage notes, implementation details, and tasks that still need to be done.

If you have any questions, feel free to ask around on the IRC channel.

Packaging

We'd love it if you helped us bring sif to your distribution. The repository provides a Makefile for building and packaging sif for any distro; consult your distribution's documentation for details.