Thank you for considering contributing to Codeowners Plus! We welcome contributions from the community to improve and expand this project. This document outlines how to get involved.
- Search existing issues to see if your concern has already been raised.
- Open a new issue if you find a bug, have a suggestion, or encounter a problem.
- Provide as much detail as possible, including steps to reproduce the issue and any relevant context.
Note
Running locally still requires real Github PRs to exist that you are testing against.
go run main.go -token <your_gh_token> -dir ../chaturbate -pr <pr_num> -repo multimediallc/chaturbate -v true -quiet=truego run tools/cli/main.go <command> [flags]- Fork the repository
- Create a new branch for your changes
- After making code changes, run
./scripts/covbadge.shto update the code coverage badge (this will be enforced in GHA checks) - Commit your changes with clear and descriptive commit messages
- Push your changes to your fork
- Open a pull request against the
mainbranch of this repository
- Follow Go best practices.
- Follow additional rules in styleguide markdown files.
- Write clear, concise, and well-documented code.
- Include unit tests for any new functionality.
- All pull requests will be reviewed by maintainers.
- Address feedback promptly and communicate if additional time is needed.
- Once approved, your changes will be merged by a maintainer.
- Join discussions in the issues section to help troubleshoot or brainstorm solutions.
- Respectfully engage with others to maintain a friendly and constructive environment.