Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
seshafi authored Jan 9, 2025
1 parent 613045f commit 0baf367
Showing 1 changed file with 10 additions and 22 deletions.
32 changes: 10 additions & 22 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,7 @@ If you are reporting a bug, please include:
* Your operating system name and version.
* Any details about your local setup that might be helpful in troubleshooting.
* Detailed steps to reproduce the bug.

### Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
wanted" is open to whoever wants to implement it.

### Implement Features

Look through the GitHub issues for features. Anything tagged with "enhancement"
and "help wanted" is open to whoever wants to implement it.
* Whether you would like to attempt fixing the bug yourself and a brief overview of how you would like to do so.

### Write Documentation

Expand All @@ -42,22 +33,16 @@ If you are proposing a feature:

Ready to contribute? Here's how to set up `pystats` for local development.

1. Download a copy of `pystats` locally.
2. Install `pystats` using `poetry`:
1. Follow the instructions in the [README file](https://github.com/UBC-MDS/Group24-pystats/blob/main/README.md) to install `pystats` on your machine.
2. Use `git` (or similar) to create a branch for local development and make your changes:

```console
$ poetry install
$ git switch -c name-of-your-bugfix-or-feature
```

3. Use `git` (or similar) to create a branch for local development and make your changes:
3. When you're done making changes, check that your changes conform to any code formatting requirements and pass any tests.

```console
$ git checkout -b name-of-your-bugfix-or-feature
```

4. When you're done making changes, check that your changes conform to any code formatting requirements and pass any tests.

5. Commit your changes and open a pull request.
4. Commit your changes and open a pull request.

## Pull Request Guidelines

Expand All @@ -70,4 +55,7 @@ Before you submit a pull request, check that it meets these guidelines:
## Code of Conduct

Please note that the `pystats` project is released with a
Code of Conduct. By contributing to this project you agree to abide by its terms.
Code of Conduct. By contributing to this project you agree to abide by its terms. Please see the [Conduct File](https://github.com/UBC-MDS/Group24-pystats/blob/main/CONDUCT.md) for more details.

## Attribution
This contribution template is adapted from the [py-pkgs-cookiecutter](https://py-pkgs-cookiecutter.readthedocs.io/en/latest/quickstart.html) default.

0 comments on commit 0baf367

Please sign in to comment.