-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
23 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |