1
0
mirror of https://github.com/danog/psalm.git synced 2024-12-11 08:49:52 +01:00
psalm/CONTRIBUTING.md

22 lines
976 B
Markdown
Raw Normal View History

2017-12-31 23:02:53 +01:00
# 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.
2017-12-31 23:02:53 +01:00
## 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.
2017-12-31 23:02:53 +01:00
## Pull Requests
2020-02-24 17:32:40 +01:00
[Heres a guide to the codebase you may find useful](docs/how_psalm_works.md).
2017-12-31 23:02:53 +01:00
Before you send a pull request, make sure you follow these guidelines:
2020-02-24 17:32:40 +01:00
* Make sure to run `composer tests` and `./psalm` to ensure that Travis builds will pass
2017-12-31 23:02:53 +01:00
* Dont forget to add tests!