-
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.
Showing
1 changed file
with
45 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,45 @@ | ||
# Contributing to actix-permissions | ||
|
||
Thanks for your interest and work in actix permissions. | ||
|
||
## Getting Started | ||
|
||
Actix-permissions [open issues are here](https://github.com/eisberg-labs/actix-permissions/issues). Issues can include bugs to fix, features to add, or documentation that looks outdated. | ||
|
||
For some tips on contributing to open source, this [post is helpful](https://smartbear.com/blog/14-ways-to-contribute-to-open-source-without-being/). | ||
|
||
## Contributions | ||
|
||
Everyone is welcome to contribute. | ||
|
||
Contributions should be made in the form of GitHub pull requests. Each pull request will | ||
be reviewed by a core contributor (someone with permission to land patches) and either landed in the | ||
main tree or given feedback for changes that would be required. | ||
|
||
## Pull Request Checklist | ||
|
||
- Branch from the master branch and, if needed, rebase to the current master | ||
branch before submitting your pull request. If it doesn't merge cleanly with | ||
master you may be asked to rebase your changes. | ||
|
||
- Commits should be as small as possible, while ensuring that each commit is | ||
correct independently (i.e., each commit should compile and pass tests). | ||
|
||
- Commit messages should be capitalized and short. For other | ||
recommendations on writing commit messages take a look | ||
at [this helpful post](https://cbea.ms/git-commit/). | ||
|
||
- Don't put submodule updates in your pull request unless they are to landed | ||
commits. | ||
|
||
- If your patch is not getting reviewed or you need a specific person to review | ||
it, you can @-reply a reviewer asking for a review in the pull request or a | ||
comment. | ||
|
||
- Add tests relevant to the fixed bug or new feature. | ||
|
||
## Conduct | ||
|
||
We follow the [Rust Code of Conduct](http://www.rust-lang.org/conduct.html). | ||
|
||
All code in this repository is under the MIT/Apache-2.0. |