Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
89 lines (62 loc) · 3.2 KB

CONTRIBUTING.md

File metadata and controls

89 lines (62 loc) · 3.2 KB

Contributing to PFControl

Contributions are welcome!

How to Contribute

  • Fork the repo and open a pull request (to the canary branch so it can be tested on canary.pfcontrol.com).
  • Follow the existing code style and conventions.
  • Run checks before submitting:
    • npm run lint to check for lint errors.
    • npm run format to auto-format your code.
    • npm run type-check to ensure type safety.
  • For larger changes, open an issue first to discuss your proposal.
  • Keep pull requests focused: One feature or fix per PR is preferred.

Commit Messages

  • Use clear, descriptive commit messages.
  • Follow Conventional Commits if possible (e.g., fix: correct typo in login page).

Code Style

  • Use Prettier for formatting (npm run format).
  • Use ESLint for linting (npm run lint).
  • Prefer TypeScript for all new code.
  • Keep functions and files small and focused.

Testing

  • Add or update tests for new features or bug fixes.
  • Ensure all tests pass before submitting a PR.
  • If possible, add unit tests for backend and frontend changes.

Environment Variables

  • If you're adding features that require environment variables, update .env.example and document them in this README.
  • Never commit secrets or real credentials.

Documentation

  • Update documentation and comments as needed.
  • If you add a new feature, update the relevant docs or README sections.

Pull Request Checklist

Before submitting a PR, please ensure:

  • Code compiles and builds (npm run build).
  • Lint and format checks pass.
  • Type checks pass.
  • PR description explains the change and references any related issues.

Reporting Issues

  • Search existing issues before opening a new one.
  • Provide clear steps to reproduce, expected vs. actual behavior, and screenshots/logs if possible.

Code of Conduct

  • Be respectful and inclusive.
  • No harassment, discrimination, or inappropriate behavior.

Contributor License Agreement

By making a contribution to this project, you certify that:

(a) The contribution was created in whole or in part by you and you have the right to submit it under the open source license indicated in the repository; or

(b) The contribution is based upon previous work that, to the best of your knowledge, is covered under an appropriate open source license and you have the right under that license to submit that work with modifications, whether created in whole or in part by you, under the same open source license (unless you are permitted to submit under a different license), as indicated in the repository; or

(c) The contribution was provided directly to you by some other person who certified (a), (b) or (c) and you have not modified it.

(d) You understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information you submit with it, including your sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.

Thank you for helping to make PFControl better!