Skip to content

Commit

Permalink
Merge pull request picassodev#105 from streeve/contributing
Browse files Browse the repository at this point in the history
Add contribution guide
  • Loading branch information
streeve authored May 24, 2024
2 parents dbf4580 + 57d8149 commit b122c53
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
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.

0 comments on commit b122c53

Please sign in to comment.