Skip to content

contributing.md

Latest commit

 

History

History
90 lines (53 loc) · 3.85 KB

contributing.md

File metadata and controls

90 lines (53 loc) · 3.85 KB

Contributing

Thank you for your interest in contributing to PanGBank-cli! This is an open-source project, and we welcome everyone to get involved.

Help or Reporting a Bug

If you have a question or found a bug? Please open an issue.

Before you do, check the Issues page to see if it's already been reported.

If you don’t see it there, create a new issue. We appreciate your input!

Adding a new feature to PanGBank-cli

Starting with an issue

If you have ideas for new features or improvements, initiate a discussion in an issue. This allows us to evaluate and discuss your suggestions together.

For minor changes like fixing typos or making small edits, create a new Pull Request (PR) directly with your proposed changes.

Setting Up the Development Environment

  1. Fork and Clone the Repository:

    • Fork the repository to your GitHub account.
    • Clone your forked repository to your local machine.

  2. Get an Environment: Create an environment with all PanGBank-cli prerequisites installed by following the installation instructions.

  3. Branch from 'dev':
    Start your changes from the dev branch, where updates for the upcoming release are integrated.

    git checkout dev

  4. Install in Editable Mode:
    To enable code editing and testing of new functionality, you can install PanGBank-cli in editable mode:

    pip install -e .[dev]
    • The [dev] part installs additional packages required for development. While not mandatory, it is recommended for an optimal development environment. Refer to the pyproject.toml file for details on the additional dependencies that will be installed.

    Installing in editable mode allows you to modify the codebase and experiment with new features directly.

  5. Apply Code Formatting with Black:
    To maintain consistent code styling, we use Black as our code formatter.

    • Code changes are automatically checked for formatting as part of our CI pipeline via a GitHub Action.
    • Ensure your code is formatted with Black before committing.

    To format your code:

    1. Install Black (e.g., pip install black).
    2. Run Black from the root of the PanGBank-cli repository: 
      black .

Tips: Configure your IDE to integrate Black for automatic code formatting as you work.

Making Your Changes

Maintain consistency in code formatting. When adding new code, closely follow the existing structure. Functions should include descriptive docstrings explaining their purpose and detailing the parameters. Ensure that argument types are specified in the function definitions.

Update Documentation

If your changes alter the tool's behavior, update the documentation to reflect them. Provide clear descriptions and, if necessary, examples of commands and their respective outputs.

Tests

Continuous Integration (CI) Workflow

We've configured a CI workflow in the Actions tab, executing PanGBank-cli on a small dataset and testing its results. If you've introduced a new feature, consider updating the CI YAML file to test it and ensure seamless integration.

Unit Tests

It is recommended to add unit test to any additions to the code. The test suite is located in the 'tests' directory at the root of the project.

Creating a Pull Request 🚀

Once you've made your changes:

  1. Create a Pull Request: Submit a pull request from your forked repository to the 'dev' branch on GitHub.

  2. Describe Your Changes: Clearly describe the modifications you've made and link any associated issue(s) in the PR description.

  3. Collaborative Review: We will review your changes, offer feedback, and engage in discussions until we collectively agree on the implementation.
⚡