mirror of
https://github.com/danog/psalm.git
synced 2024-11-26 12:24:49 +01:00
Add CONTRIBUTING
This commit is contained in:
parent
b193822f66
commit
3c1b22a8a9
19
CONTRIBUTING.md
Normal file
19
CONTRIBUTING.md
Normal file
@ -0,0 +1,19 @@
|
||||
# Contributing to Psalm
|
||||
|
||||
The following is a set of guidelines for contributing to Psalm, which is hosted in the [Vimeo Organization](https://github.com/vimeo) on GitHub.
|
||||
|
||||
Also, make sure to check out the [Contributing to Open Source on GitHub](https://guides.github.com/activities/contributing-to-open-source/) guide.
|
||||
|
||||
## Submitting Issues
|
||||
|
||||
You can create an issue [here](https://github.com/vimeo/psalm/issues/new), but before you do, follow these guidelines:
|
||||
|
||||
* Make sure that you are using the latest version (`dev-master`).
|
||||
* It’s by no means a requirement, but if it's a bug, and you provide demonstration code that can be pasted into https://getpsalm.org, it will likely get fixed faster.
|
||||
|
||||
## Pull Requests
|
||||
|
||||
Before you send a pull request, make sure you follow these guidelines:
|
||||
|
||||
* Make sure to run `composer tests` and `./psalm --find-dead-code` to ensure that Travis builds will pass
|
||||
* Don’t forget to add tests!
|
Loading…
Reference in New Issue
Block a user