This project is here to enforce our GitHub Standards for Sonatype Open Source Community Projects.
You will need:
- Python 3.12
- Poetry >= 1.8.1
- Clone this repository
- Install dependencies by running
poetry install
- Set your
GH_TOKEN
environment variable (see below) and then runpython -m github_standards
You will need a GitHub Personal Access (Fine Grained) Token with the following permissions:
- Repository Access: All Repositories
- Repository Permissions:
- Administration: Read + Write
- Contents: Read Only
- Custom Properties: Read Only
- Metadata: Read Only (Mandatory)
See CONTRIBUTING.md for details.
Remember:
This project is part of the Sonatype Nexus Community organization, which is not officially supported by Sonatype. Please review the latest pull requests, issues, and commits to understand this project's readiness for contribution and use.
- File suggestions and requests on this repo through GitHub Issues, so that the community can pitch in
- Use or contribute to this project according to your organization's policies and your own risk tolerance
- Don't file Sonatype support tickets related to this project— it won't reach the right people that way
Last but not least of all - have fun!