From 9decfa43b61cc51b3545a31f44f506a5424feb87 Mon Sep 17 00:00:00 2001 From: abdmmar Date: Sat, 18 Dec 2021 21:48:18 +0700 Subject: [PATCH] doc: add CONTRIBUTING.md --- CONTRIBUTING.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..ef3fe5e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,23 @@ +## Getting Started + +These packages are designed to make contributing as easy as possible. All work and planned features are tracked in the Issues. + +If you'd like to contribute **claim an existing issue** -or- **create a new issue**. All unassigned issues are up-for-grabs. + +Development follows the [Feature Branch Workflow][feature-workflow]: + +1. Fork the repo +2. Clone your fork +3. Create a `feat/[name]` branch +4. Implement your feature +5. Commit the changes +6. Create a PR to merge the feature branch +7. Reference the issue in the PR + +[feature-workflow]: https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow + +## Developing + +Open `index.html` with [Live Server][live-server] you ready to go. + +[live-server]: https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer