🧑🦱 Contributions are welcome!
🗒️ Table of content
- Code contribution
- Contributing code
- Building the project
- Becoming a maintainer
- Reporting a bug
- Unexpected behavior
- Security issues
- Feature suggestion
To contribute code to the project, follow these steps:
- Open issues section and choose an issue to work on.
- Fork the repository on GitHub.
- Clone your forked repository to your local machine.
- Create a new branch for your changes.
- Install dependencies with
make build(required to havemakeandgo(version from go.mod) installed) - Complete an issue and commit it.
- Follow the style guide.
- Test your code thoroughly.
- Write clear and concise commit messages.
- Push your changes to your forked repository.
- Create a pull request to the main repository.
- Pull request will not be merged until it is approved by a maintainer and passes all checks.
[List of code contributors] is updated weekly.
To make a code contribution, build the project:
Clone from GitHub
git clone git@github.com:statloc/cli.gitInstall dependencies (requires make to be installed, go version is 1.25.1)
make buildRun linter and tests
makeTo become a maintainer:
- Open an issue from a template.
- Provide a brief description of your contributions and experience.
- Wait for a response from the maintainers.
Alternatively, contact one of the maintainers from the maintainers list and request a maintainer role.
To report an unexpected behavior, follow these steps:
- Open an issue from a template.
- Provide a description of the unexpected behavior following the template.
- Fill as many fields as possible.
To report a security issue, follow these steps:
To report a vulnerability or any other security issue, please contact any code owner from this list.
To suggest a feature, follow this steps:
- Open an issue from a template.
- Provide a description of the feature following the template.
- Fill as many fields as possible.