Skip to content

Edit contributing.md, add PR template #1059

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

Open
kushalkolar wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Edit contributing.md, add PR template #1059

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3241410
Update CONTRIBUTING.md
kushalkolar May 22, 2026
698c9cb
Create pull_request_template.md
kushalkolar May 22, 2026
99333b1
Update CONTRIBUTING.md
kushalkolar Jun 8, 2026
b3b630d
Apply suggestion from @clewis7
clewis7 Jun 9, 2026
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
4 changes: 4 additions & 0 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Type of PR:
- [ ] minor/trivial bugfix
- [ ] other minor/trivial change (ex: small changes to docs, typos, etc.)
- [ ] new features: Reference the issue that describes the new feature and outlines the implementation, this helps facilitate rapid review and approval of your PR.
13 changes: 9 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,15 @@

`fastplotlib` is a next-generation plotting library built on top of the `pygfx` rendering engine that leverages modern
GPU hardware and new graphics APIs to build large-scale scientific visualizations. We welcome and encourage contributions
from everyone! :smile:
from everyone! :smile:

The rest of this guide explains how to contribute; if you have questions about the process, please
reach out on [GitHub Discussions](https://github.com/fastplotlib/fastplotlib/discussions).

If your contribution/PR isn't minor (ex: more than a bugfix, small change in the docs, etc.) **please open an issue first** that briefly
describes what you want to contribute and how you plan to implement it. This makes it much easier for us to review your PR, and
also facilitates more rapid approval of your PR.

> **_NOTE:_** If you are already familiar with contributing to open-source software packages,
> please check out the [Quick Guide](#contributing-quick-guide)!

Expand Down Expand Up @@ -72,9 +76,10 @@ autonomously is not permitted.

In order to contribute, you will need to do the following:

1) Create your own branch
2) Make sure that tests pass
3) Open a Pull Request
1) If your contribution isn't trivially small (ex: bugfix, small docs change, etc.) please open an issue that briefly describes your contribution and how you plan to implement it.
2) Create your own branch
3) Make sure that tests pass
4) Open a Pull Request

The `fastplotlib` package follows the [Git feature branch](https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow) workflow. In essence, `main` is the primary branch to which no one is allowed to
push directly. All development happens in separate feature branches that are then merged into `main` once we have determined they are ready. When enough changes have accumulated, a new release is
Expand Down
Loading