diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6ec2d7ab3..dca710694 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,15 +6,6 @@ If you encounter a problem when using infer or if you have any questions, please open a [GitHub issue](https://github.com/facebook/infer/issues/). -- [ ] Check first if your issue is addressed in the [FAQ](http://fbinfer.com/support.html#troubleshooting). -- [ ] Check also if your issue has already been [reported](https://github.com/facebook/infer/issues/). -- [ ] Include the version of infer you are using (`infer --version`). -- [ ] Include the full list of the commands you are running. -- [ ] Include the full output of infer in a paste, for instance a [gist](https://gist.github.com/). -- [ ] If possible, give a minimal example to reproduce your problem (for instance, some code where - infer reports incorrectly, together with the way you run infer to reproduce the incorrect - report). - ## Hacking on the Code We welcome contributions via [pull requests on GitHub](https://github.com/facebook/infer/pulls). diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md new file mode 100644 index 000000000..9455a104b --- /dev/null +++ b/ISSUE_TEMPLATE.md @@ -0,0 +1,10 @@ +Please make sure your issue is not addressed in the [FAQ](http://fbinfer.com/support.html#troubleshooting). + +Please include the following information: +- [ ] The version of infer from `infer --version`. +- [ ] Your operating system and version, for example "Debian 9", "MacOS High Sierra", whether you are using Docker, etc. +- [ ] Which command you ran, for example `infer -- make`. +- [ ] The full output in a paste, for instance a [gist](https://gist.github.com/). +- [ ] If possible, a minimal example to reproduce your problem (for instance, some code where + infer reports incorrectly, together with the way you run infer to reproduce the incorrect + report). diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..2fb7732db --- /dev/null +++ b/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1 @@ +Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for how to set up your development environment and run tests.