This repository has been archived by the owner on Oct 19, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 42
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
38 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,38 @@ | ||
## Contributing | ||
|
||
Hi there! We're thrilled that you'd like to contribute to masquerade. Your help is essential for keeping it great. | ||
|
||
Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](LICENSE). | ||
|
||
## Opening an issue | ||
. | ||
Before opening an issue, please be sure that your issue hasn't already been asked by using [GitHub search](https://help.github.com/articles/searching-issues/) | ||
|
||
Here are a few things that will help us help resolve your issues: | ||
|
||
- A descriptive title that gives an idea of what your issue refers to | ||
- A thorough description of the issue, (one word descriptions are very hard to understand) | ||
- Screenshots (if appropriate) | ||
- Links (if appropriate) | ||
|
||
## Submitting a pull request | ||
|
||
0. Clone the repository | ||
0. Configure and install the dependencies: (See the [README](README.md) for more details) | ||
0. Create a new branch: `git checkout -b my-branch-name` | ||
0. Make your change, add tests, and make sure the tests still pass | ||
0. Push to your branch and [submit a pull request][pr] | ||
0. Wait for your pull request to be reviewed and merged! | ||
|
||
Here are a few things you can do that will increase the likelihood of your pull request being accepted: | ||
|
||
- Follow the [style guide][style]. | ||
- Write tests. | ||
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests. | ||
- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). | ||
|
||
## Resources | ||
|
||
- [Contributing to Open Source on GitHub](https://guides.github.com/activities/contributing-to-open-source/) | ||
- [Using Pull Requests](https://help.github.com/articles/using-pull-requests/) | ||
- [GitHub Help](https://help.github.com) |