Skip to content

Latest commit

 

History

History
43 lines (32 loc) · 2.16 KB

File metadata and controls

43 lines (32 loc) · 2.16 KB

Contributing to Newfoundcodes

Thank you for helping build open technology for the public commons. Newfoundcodes welcomes code, tests, documentation, design, research, reviews, security improvements, and maintenance work.

Before you begin

  1. Read the target repository's README and any project-specific contribution instructions.
  2. Search existing issues and pull requests to avoid duplicating active work.
  3. For a substantial feature, architecture change, or new public interface, open an issue before implementation so scope and approach can be discussed.
  4. Never include credentials, private data, or an unpatched vulnerability in a public issue. Use the process in SECURITY.md for security reports.

Project-specific instructions take precedence over this organization-wide default.

Make a contribution

  1. Fork the repository or create a branch in the repository if you have write access.
  2. Keep the change focused. Separate unrelated fixes into separate pull requests.
  3. Follow the project's existing conventions and avoid unnecessary dependencies.
  4. Add or update tests for changed behavior.
  5. Update documentation when behavior, interfaces, configuration, or operational requirements change.
  6. Run the repository's documented formatting, linting, type-checking, and test commands.
  7. Open a pull request and explain the problem, the chosen approach, verification performed, and any compatibility or security implications.

Review expectations

Reviewers may ask for changes that improve correctness, maintainability, security, accessibility, performance, interoperability, or documentation. Address feedback with follow-up commits or explain the tradeoff when another approach is preferable.

A contribution may be closed when it is out of scope, duplicates existing work, cannot be maintained safely, or remains inactive after maintainers request changes. Closing a contribution is not a judgment of the contributor.

Community standards

Participation in Newfoundcodes spaces is governed by the Code of Conduct. By contributing, you agree that your work will be distributed under the license stated by the target repository.