Skip to content

Latest commit

 

History

History
34 lines (25 loc) · 3.34 KB

CONTRIBUTING.md

File metadata and controls

34 lines (25 loc) · 3.34 KB

Contributing GitHub contributors JavaScript Style Guide

CI/CD Pipeline Coverage StatusCypress tests Gitlab pipeline status Crowdin GitHub issues by-label "help wanted" GitHub issues by-label "good first issue"

Code Contributions

The ten minimum requirements for code contributions are:

  1. All Pull Requests must be based off the develop branch.
  2. The code must be compliant with the configured ESLint rules based on the JS Standard Code Style.
  3. All PRs should have a dedicated scope (e.g. not mixing code refactorings with delivering a new feature) and reasonable size.
  4. All new and changed code should have a corresponding unit and/or integration test.
  5. New and changed challenges must have a corresponding e2e test.
  6. Noise (e.g. unnecessary comments) generated by AI tools must be removed before opening a PR.
  7. All status checks must pass for the last commit within your PR.
  8. All Git commits within a PR must be signed off to indicate the contributor's agreement with the Developer Certificate of Origin.
  9. Cintributing to translations should be done via Crowdin and not via GitHub PRs.
  10. Particularly low-effort contributions (e.g. incomplete typo fixes in a single file, trivial text changes, code formatting) or any forms of potential "contribution farming" must not be submitted as PRs. Doing so more than once might be considered spamming and handled accordingly.

Contribution Guidelines

You can find our detailed contribution guidelines over here:

https://pwning.owasp-juice.shop/companion-guide/latest/part3/contribution.html

I18N Contributions

Learn all about our crowdsourced translation project on Crowdin here: https://pwning.owasp-juice.shop/companion-guide/latest/part3/translation.html