Skip to content

update Contributing workflow #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nicolelink33 merged 1 commit into from
Jan 10, 2026
Merged

update Contributing workflow #19

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 23 additions & 22 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ You can contribute in many ways, for example:

### Report Bugs

Report bugs at https://github.com/hpalafoxp/dsci524team17/issues.
Report bugs at https://github.com/UBC-MDS/dumbpy/issues.

**If you are reporting a bug, please follow the template guidelines. The more
detailed your report, the easier and thus faster we can help you.**
Expand All @@ -39,68 +39,69 @@ happy for any support that they can get.

### Write Documentation

dsci524team17 could always use more documentation, whether as
dumbpy could always use more documentation, whether as
part of the official documentation, in docstrings, or even on the web in blog
posts, articles, and such. Just
[open an issue](https://github.com/hpalafoxp/dsci524team17/issues)
[open an issue](https://github.com/UBC-MDS/dumbpy/issues)
to let us know what you will be working on so that we can provide you with guidance.

### Submit Feedback

The best way to send feedback is to file an issue at
https://github.com/hpalafoxp/dsci524team17/issues. If your feedback fits the format of one of
https://github.com/UBC-MDS/dumbpy/issues. If your feedback fits the format of one of
the issue templates, please use that. Remember that this is a volunteer-driven
project and everybody has limited time.

## Get Started!

Ready to contribute? Here's how to set up dsci524team17 for
Ready to contribute? Here's how to set up dumbpy for
local development.

1. Fork the https://github.com/hpalafoxp/dsci524team17
repository on GitHub.
2. Clone your fork locally (*if you want to work locally*)
1. Clone the repository locally:

```shell
git clone [email protected]:your_name_here/dsci524team17.git
git clone https://github.com/UBC-MDS/dumbpy.git
cd dumbpy
```

3. [Install hatch](https://hatch.pypa.io/latest/install/).
2. [Install hatch](https://hatch.pypa.io/latest/install/).

4. Create a branch for local development using the default branch (typically `main`) as a starting point. Use `fix` or `feat` as a prefix for your branch name.
3. Create a branch for local development using `dev` as a starting point:

```shell
git checkout main
git checkout -b fix-name-of-your-bugfix
git checkout dev
git pull
git checkout -b feature-name
```

Now you can make your changes locally.

5. When you're done making changes, apply the quality assurance tools and check
4. When you're done making changes, apply the quality assurance tools and check
that your changes pass our test suite. This is all included with tox

```shell
hatch run test:run
```

6. Commit your changes and push your branch to GitHub. Please use [semantic
5. Commit your changes and push your branch to GitHub. Please use [semantic
commit messages](https://www.conventionalcommits.org/).

```shell
git add .
git commit -m "fix: summarize your changes"
git push -u origin fix-name-of-your-bugfix
git commit -m "summarize your changes"
git push -u origin HEAD
```

7. Open the link displayed in the message when pushing your new branch in order
to submit a pull request.
6. Open a pull request from your branch into `dev` and request at least one teammate review before merging.


### Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put your
1. The PR must be reviewed and approved by at least one teammate before merging.
2. The pull request should include tests.
3. If the pull request adds functionality, the docs should be updated. Put your
new functionality into a function with a docstring.
3. Your pull request will automatically be checked by the full test suite.
4. Your pull request will automatically be checked by the full test suite.
It needs to pass all of them before it can be considered for merging.
Loading