Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
70 lines (45 loc) · 3.3 KB

CONTRIBUTING.md

File metadata and controls

70 lines (45 loc) · 3.3 KB

Contributing to template-python

First off, thank you for considering contributing to template-python! It's people like you that make this project great.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct. Please report any unacceptable behavior to the project team.

Security Vulnerabilities

Important

Please do not report security vulnerabilities through public GitHub issues.

If you discover a security issue, please refer to our Security Policy for instructions on how to safely report it.

How Can I Contribute?

There are many ways to contribute to template-python, and not all of them involve writing code:

  • Reporting Bugs: Help us improve by submitting detailed bug reports via our issue tracker.
  • Suggesting Features: Propose new features or enhancements that could benefit the project.
  • Improving Documentation: Fix typos, add examples, or write new guides.
  • Writing Code: Fix bugs, implement features, or improve performance.
  • Helping Others: Answer questions in Discussions or issue comments.

For general questions and help, please see SUPPORT.md.

Contributing Code

If you are contributing code, please follow these structured steps:

1. Development Setup

Before you start coding, please refer to our Development Guide for detailed instructions on:

  • Setting up your local environment
  • Installing dependencies
  • Running the test suite
  • Code formatting and linting standards

2. Finding an Issue

  • Look for issues tagged with good first issue or help wanted if you are a new contributor.
  • If you plan to work on a major feature, please open an issue or discussion first to talk it over with the maintainers.

3. Making Changes

  1. Fork the Repository: Fork the template-python repository to your GitHub account.
  2. Create a Branch: Create a new branch from main for your work (e.g., git checkout -b feat/add-new-feature).
  3. Write Code: Implement your changes, adhering to the project's coding standards.
  4. Write Tests: Add unit tests or integration tests for your changes to ensure stability.
  5. Run Tests: Ensure all tests and linters pass locally before committing.

4. Committing Your Changes

  • Write clear, concise commit messages.
  • We recommend using Conventional Commits (e.g., feat: add support for X, fix: resolve issue with Y).
  • If you are adding a new file, please include the appropriate Apache 2.0 copyright and license header at the top.

5. Submitting a Pull Request

  1. Push your branch: git push origin your-branch-name.
  2. Open a Pull Request: Open a PR against the main branch of the upstream repository.
  3. Fill out the PR Template: Provide a clear description of your changes, link to any relevant issues (e.g., Closes #123), and complete any required checklists.
  4. Pass CI: Ensure all GitHub Actions CI checks pass.
  5. Review: Address any feedback from the maintainers. Once approved and checks pass, a maintainer will merge your PR.

Licensing

By contributing to template-python, you agree that your contributions will be licensed under its Apache 2.0 License.