1
0
mirror of https://github.com/danog/psalm.git synced 2024-12-13 01:37:23 +01:00
psalm/CONTRIBUTING.md
Muhammad Kamran 5331a3e8b8
Update CONTRIBUTING.md (#3235)
I could not find the 'dev-master' branch, assumed it was renamed to 'master'.
2020-04-26 18:59:33 -04:00

22 lines
976 B
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 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.
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 (`master`).
* Its by no means a requirement, but if it's a bug, and you provide demonstration code that can be pasted into https://psalm.dev, it will likely get fixed faster.
## Pull Requests
[Heres a guide to the codebase you may find useful](docs/how_psalm_works.md).
Before you send a pull request, make sure you follow these guidelines:
* Make sure to run `composer tests` and `./psalm` to ensure that Travis builds will pass
* Dont forget to add tests!