Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
67 lines (45 loc) · 3.3 KB

CONTRIBUTING.md

File metadata and controls

67 lines (45 loc) · 3.3 KB

Contributing to Insight

First off, thank you for considering contributing to Insight! It's people like you that make this project a great tool for developers.

We welcome any and all contributions, from bug reports to new features. To ensure a smooth and collaborative process, please read through the following guidelines.

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to the project maintainers.

How Can I Contribute?

Reporting Bugs

If you find a bug, please make sure to do the following:

  1. Search existing issues: Before creating a new issue, please check to see if the bug has already been reported.
  2. Provide a clear title and description: The title should be concise and the description should include as much relevant information as possible, including steps to reproduce the bug.
  3. Include details about your environment: Let us know what operating system you're on, what version of Python you're using, and any other relevant details.

Suggesting Enhancements

If you have an idea for a new feature or an improvement to an existing one, please:

  1. Search existing issues: Check if the enhancement has already been suggested.
  2. Provide a clear title and description: Explain the enhancement in detail and why it would be a valuable addition to the project.

Your First Code Contribution

Unsure where to begin? A great place to start is by looking for issues tagged with good first issue. These are issues that are well-suited for new contributors.

Pull Request Process

  1. Fork the repository: Create your own fork of the project to your GitHub account.
  2. Create a new branch: Make a new branch from main for your changes. 
    git checkout -b name-of-your-feature-or-fix
  3. Make your changes: Make your changes to the code, and be sure to follow the coding style guidelines below.
  4. Add tests: If you're adding a new feature, please include tests to ensure it works as expected.
  5. Ensure all tests pass: Run the test suite to make sure your changes haven't broken anything.
  6. Commit your changes: Write a clear and concise commit message.
  7. Push to your fork: 
    git push origin name-of-your-feature-or-fix
  8. Submit a pull request: Open a pull request from your fork to the main branch of the original repository.

Pull Request Title

When you submit a pull request, please ensure that the title references the issue number it addresses. This helps us to keep track of which issues are being worked on and to link the pull request to the relevant discussion.

The title of your pull request should be in the following format:

feat: A brief description of the feature (fixes #123)
fix: A brief description of the fix (fixes #456)
docs: A brief description of the documentation change (fixes #789)

Coding Style

  • This project follows the PEP 8 style guide for Python code.
  • Please include docstrings for all new functions and classes.
  • Use comments to explain any complex or non-obvious parts of your code.

Thank you again for your contribution.