Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
39 lines (28 loc) · 1.23 KB

CONTRIBUTING.md

File metadata and controls

39 lines (28 loc) · 1.23 KB

Contributing to Dockette

Thanks for helping improve Dockette repositories.

How to contribute

  1. Start with an issue

    • Search existing issues and pull requests first.
    • For larger changes, open an issue before coding.

  2. Fork and branch

    • Fork the target repository.
    • Create a branch from master (for example fix/nginx-hsts or docs/readme-update).

  3. Keep changes focused

    • Solve one problem per pull request.
    • Follow existing code style and project structure.
    • Update documentation when behavior or configuration changes.

  4. Verify locally

    • Run relevant checks (tests, linters, image builds if available).
    • Avoid environment-specific behavior.

  5. Open a pull request

    • Use clear commit messages and explain why the change is needed.
    • Link related issues (for example Closes #123).
    • Describe what changed and how you tested it.

Pull request checklist

  • Tests and checks pass locally.
  • Documentation and examples are updated when needed.
  • No secrets, tokens, or private credentials are committed.
  • Breaking changes are clearly documented.

Security

Do not open public issues for security vulnerabilities. Follow the repository SECURITY.md disclosure instructions.