Skip to content

Commit

Permalink
update doc with black
Browse files Browse the repository at this point in the history
  • Loading branch information
JeanMainguy committed Oct 29, 2024
1 parent 99249ed commit 798f850
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions docs/dev/contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ If you have ideas for new features or improvements, initiating a discussion in a

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


## Setting Up the Development Environment

1. **Fork the Repository:** Start by forking the repository to your GitHub account. 🍴
Expand All @@ -18,25 +19,29 @@ For minor changes like fixing typos or making small edits, feel free to create a

4. **Branch from 'dev':** Begin your changes from the 'dev' branch, where we incorporate changes for the upcoming release.

5. **Install in Editable Mode:** To enable seamless code editing and testing of new functionality, install PPanGGOLiN in editable mode using the following command:
5. **Install in Editable Mode:** To enable code editing and testing of new functionality, you can install PPanGGOLiN in editable mode using the following command:

```bash
pip install -e .
```

This allows you to modify the code and experiment with new features directly.

```{note}
Note: Currently, we are not utilizing any auto formatters (like autopep8 or black). Kindly refrain from using them, as it could introduce extensive changes across the project, making code review challenging for us.
6. **Apply Code Formatting with Black:** We have integrated Black as our code formatter to maintain consistent styling. Code changes are automatically checked via a GitHub Action in our CI, so ensure your code is formatted with Black before committing.


```{tip}
Integrate Black with your IDE to automatically format your changes and avoid formatting-related CI failures.
```


## Making Your Changes

We encourage consistency in code formatting; when adding new code, try to follow the existing code structure as closely as possible. Functions should include descriptive docstrings explaining their purpose and detailing the parameters. Ensure that argument types are specified in the function definitions.
Keep it consistent! Match the existing code style, add docstrings to describe functions, and specify argument types.

## Update Documentation

It's essential to update the documentation to reflect your changes. Provide clear descriptions and, if necessary, examples of commands and their respective outputs.
Update docs to reflect changesclear descriptions and examples are always helpful!

## Tests

Expand Down

0 comments on commit 798f850

Please sign in to comment.