-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #289 from Julia-Tempering/contrib
Add contribution guidelines
- Loading branch information
Showing
1 changed file
with
22 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# Contributing Guide | ||
|
||
Thank you for your interest in contributing to Pigeons.jl! There are multiple ways to contribute, and we appreciate all contributions. | ||
|
||
## Ways to Contribute | ||
|
||
### Bug Reports and Feature Requests | ||
|
||
If you are working with Pigeons, and run into a bug, or require additional features, we definitely want to know about it. Please let us know by creating a [GitHub Issue](https://github.com/PigeonsAD/Pigeons.jl/issues). | ||
|
||
### How to Submit a Pull Request | ||
|
||
If you would like to contribute, please feel free to open a pull request. The pull request should: | ||
|
||
- Include a small unit test | ||
- Not contain any unrelated changes | ||
- Be an isolated change. Independent changes should be submitted as separate pull requests as this makes reviewing easier. | ||
|
||
## Code of Conduct | ||
|
||
As a Julia Project we expect all participants to abide by the [Julia Community Standards](https://julialang.org/community/standards/). | ||
|