Skip to content

Commit

Permalink
doc: add CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
abdmmar committed Dec 18, 2021
1 parent 018ab62 commit 9decfa4
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 9decfa4

Please sign in to comment.