Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (29 loc) · 1.75 KB

CONTRIBUTING.md

File metadata and controls

47 lines (29 loc) · 1.75 KB
Raw

Contributing

This project welcomes contributions. You may open an issue to request a new feature or report a bug. You may also start a Discussion thread to engage other users on a specific topic.

If you would like to propose a feature change, please open an issue first, so that we can discuss it. If you prefer to create a PR directly, it should be narrowly scoped, well tested, well documented, and conform to all existing conventions.

All contributors are expected to have read and agreed with the Code of Conduct.

Thank you for contributing to this project.

Types of Contributions

Besides contributing targeted bug fixes and enhancements, PolicyChecks is also open to expanding the set of badges that we provide, on condition that doing so (a) does not require any additional permissions beyond repository Administration: Read, and (b) the badge status can be reported on the basis of a single GitHub API endpoint, and does not require any non-trivial inference.

Local Development

PolicyChecks is a Node.js project. Use Node.js 24 or newer - or simply refer to the .nvmrc file.

Install dependencies from the lockfile:

npm ci

Use npm install only when intentionally updating dependencies and committing the resulting lockfile change.

Run the development server:

npm run dev

Run the standard verification commands:

npm run typecheck
npm test
npm run build

The full local check used by CI is:

npm run check

.env.example contains non-secret local defaults only. Tests do not require GitHub credentials. If authenticated local development is needed, copy .env.example to the ignored .env file and populate credentials from your own credentials manager. Do not commit credentials.