diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 2b1fece0..40ac206d 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -104,13 +104,17 @@ Please open an issue with a proposal for a new feature or refactoring before starting on the work. We don't want you to waste your efforts on a pull request that we won't want to accept. -## Submitting Changes +## Pull requests -* Open a new issue in the [Issue tracker](https://github.com/necolas/react-native-web/issues). -* Fork the repo. -* Create a new feature branch based off the `master` branch. -* Make sure all tests pass and there are no linting errors. -* Submit a pull request, referencing any issues it addresses. +**Before submitting a pull request,** please make sure the following is done: + +1. Fork the repository and create your branch from `master`. +2. If you've added code that should be tested, add tests! +3. If you've changed APIs, update the documentation. +4. Ensure the tests pass (`yarn test`). +5. Lint and format your code (`yarn fmt && yarn lint`). + +You can now submit a pull request, referencing any issues it addresses. Please try to keep your pull request focused in scope and avoid including unrelated commits. diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 267d76a9..fbb567d3 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,30 +1,20 @@ - +**Do you want to request a *feature* or report a *bug*?** **What is the current behavior?** -Link to minimal test case: (template: [codepen](https://codepen.io/necolas/pen/PZzwBR?editors=0010)) - -**What is the expected behaviour?** - -**Steps to reproduce** +**If the current behavior is a bug, please provide the steps to reproduce and +if a minimal demo of the problem via Glitch or similar (template: +https://glitch.com/edit/#!/react-native-web-playground).** 1. 2. -**Environment (include versions)** +**What is the expected behavior?** -OS: -Device: -Browser: -React Native for Web (version): -React (version): +**Environment (include versions). Did this work in previous versions?** + +* OS: +* Device: +* Browser: +* React Native for Web (version): +* React (version): diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 580d0e0b..6970708e 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,18 +1 @@ - - -**This patch solves the following problem** - -**Test plan** - -**This pull request** - -- [ ] includes documentation -- [ ] includes tests -- [ ] includes benchmark reports -- [ ] includes an interactive example -- [ ] includes screenshots/videos +**Before submitting a pull request,** please make sure you have followed the steps the CONTRIBUTING guide.