Skip to content

Commit

Permalink
Create CONTRIBUTING.md [no ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
smistad authored Nov 15, 2023
1 parent 85ef202 commit a08c116
Showing 1 changed file with 46 additions and 0 deletions.
46 changes: 46 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Contributing to FAST-Pathology
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

- Reporting a bug
- Asking questions
- Discussing the current state of the code
- Submitting a fix
- Proposing new features

## Questions and discussion
Please use our [Discussions forum on GitHub](https://github.com/AICAN-Research/FAST-Pathology/discussions) for asking questions or discussing FAST-Pathology.
There are no stupid questions, so don't hesitate to ask.
We also love to see how you use FAST-Pathology in your projects, so please show and tell us.
Please also see our [code of conduct](https://github.com/AICAN-Research/FAST-Pathology/blob/master/.github/CODE_OF_CONDUCT.md).

## Submitting code
Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)).
Note that most of FAST-Pathology's functionality actually comes from the [FAST](https://github.com/smistad/FAST) framework,
FAST-Pathology is essentially a graphical user interface built on top of FAST.
Thus if you want to propose changes which are not part of the FAST-Pathology user interface, you should take a look at contributing to [FAST](https://github.com/smistad/FAST) instead.

We actively welcome your pull requests:

1. Fork the repo and create your branch from `master`.
2. Modify the code in your branch
3. Make sure the software runs and works
4. Submit the pull request

If you are unsure how to do this properly, just ask us at the [Discussions forum on GitHub](https://github.com/AICAN-Research/FAST-Pathology/discussions).

When you submit code changes, your submissions will be under the [BSD-2 clause license](https://github.com/AICAN-Research/FAST-Pathology/blob/master/LICENSE.md) that covers the project.

## Report bugs
We use [GitHub issues](https://github.com/AICAN-Research/FAST-Pathology/issues) to track public bugs.
Report a bug by [opening a new issue](https://github.com/AICAN-Research/FAST-Pathology/issues/new/choose); it's that easy!
Please try to follow the issue templates.

## Proposing new features
We use [GitHub issues](https://github.com/AICAN-Research/FAST-Pathology/issues) to track development of new features.
You can also use the [Discussions forum on GitHub](https://github.com/AICAN-Research/FAST-Pathology/discussions) for this.

## License
By contributing, you agree that your contributions will be licensed under its [BSD-2 clause license](https://github.com/AICAN-Research/FAST-Pathology/blob/master/LICENSE.md).

## References
This document was adapted from the contributor guidelines in [briandk's gist](https://gist.github.com/briandk/3d2e8b3ec8daf5a27a62).

0 comments on commit a08c116

Please sign in to comment.