forked from picassodev/picasso
-
Notifications
You must be signed in to change notification settings - Fork 0
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 picassodev#105 from streeve/contributing
Add contribution guide
- Loading branch information
Showing
1 changed file
with
17 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,17 @@ | ||
# Contributing | ||
|
||
Contributing to Picasso is easy: just open a [pull | ||
request](https://help.github.com/articles/using-pull-requests/). Make | ||
`master` the destination branch on the [Picasso | ||
repository](https://github.com/PicassoDev/Picasso) and allow edits from | ||
maintainers in the pull request. | ||
|
||
Your pull request must pass Picasso's tests, which includes using the coding | ||
style from `.clang-format` (enforced with clang-format-14) and adding doxygen | ||
documentation, and be reviewed by at least one Picasso developer. | ||
|
||
`pre-commit` is a useful tool for ensuring feature branches are ready for | ||
review by running automatic checks locally before a commit is made. | ||
[Installation details](https://pre-commit.com/#install) (once per system) and | ||
[activation details](https://pre-commit.com/#usage) (once per repo) are | ||
available. |