diff --git a/.github/ISSUE_TEMPLATE/01_bug_report.md b/.github/ISSUE_TEMPLATE/01_bug_report.md new file mode 100644 index 00000000000..98ec81e1663 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01_bug_report.md @@ -0,0 +1,46 @@ +--- +name: "🐛 Bug Report" +about: Report a reproducible bug or regression. +title: '' +labels: +- 'need triage' +- 'bug' + +--- + +## Bug Description + + + +- [ ] I have run `gradle clean` and confirmed this bug does not occur with JSC" + +Hermes version: +React Native version (if any): +Android version (if any): +Platform (most likely one of arm64-v8a, armeabi-v7a, x86, x86_64): + +## Steps To Reproduce + + + +1. +2. + +code example: + +## The Expected Behavior diff --git a/.github/ISSUE_TEMPLATE/02_feature_request.md b/.github/ISSUE_TEMPLATE/02_feature_request.md new file mode 100644 index 00000000000..44a68cc65c1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02_feature_request.md @@ -0,0 +1,29 @@ +--- +name: "🚀 Discussion & Feature Request" +about: Discuss an idea or propose improvement. +title: '' +labels: +- 'enhancement' + +--- + +## Problem + + + +## Solution + + + +## Additional Context + + diff --git a/.github/ISSUE_TEMPLATE/03_website_doc.md b/.github/ISSUE_TEMPLATE/03_website_doc.md new file mode 100644 index 00000000000..e4112a5e60f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/03_website_doc.md @@ -0,0 +1,16 @@ +--- +name: "📗 Website & Documentation Issue" +about: Report a bug or propose an idea to the Hermes website & docs. +title: '' +labels: '' + +--- + +## Description + + diff --git a/.github/ISSUE_TEMPLATE/04_thanks.md b/.github/ISSUE_TEMPLATE/04_thanks.md new file mode 100644 index 00000000000..adbed215db6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/04_thanks.md @@ -0,0 +1,14 @@ +--- +name: ❤️ Say thank you +about: Tell us how you use Hermes +title: '' +labels: '' + +--- + +## ❤️ I'm using Hermes! + + diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000000..f90751baea7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,4 @@ +contact_links: + - name: ⚛️ Need Help From React Native? + url: https://github.com/facebook/react-native/issues + about: Consider file an issue in the React Native repository. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000000..243c0604982 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,27 @@ + + +## Summary + + + +## Test Plan + + diff --git a/doc/BuildingAndRunning.md b/doc/BuildingAndRunning.md index 030a19651d7..ebe7631cb86 100644 --- a/doc/BuildingAndRunning.md +++ b/doc/BuildingAndRunning.md @@ -67,13 +67,19 @@ The primary binary is the `hermes` tool, which will be found at `build/bin/herme hermes -emit-binary -out test.hbc test.js hermes test.hbc - ## Running Tests To run the Hermes test suite: ninja check-hermes +## Formatting Code + +To automatically format all your changes, you will need `clang-format`, then +simply run: + + hermes/utils/format.sh + ### Other Tools In addition to `hermes`, the following tools will be built: