This repository has been archived by the owner on Jan 30, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
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
21 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,21 @@ | ||
# How to contribute | ||
|
||
🎉 Thanks for taking an interest in our open source projects! 🎉 | ||
|
||
The following is a set of guidelines for contributing to HomeX Labs and its packages, which are hosted in the [HomeX Labs Organization](https://github.com/HomeXLabs). These guidelines are not set in stone, feel free to propose changes to this in a pull request. 🙇 | ||
|
||
## Submitting changes | ||
|
||
Feel free to submit a github issues for features, bugs or inquires by filling out one of our provided templates | ||
|
||
for making pull requests fork and create your branch and submit a pull request to the upstream the main repository https://github.com/HomeXLabs/use-unique-id.git | ||
|
||
## Testing | ||
|
||
Currently all tests are done with jest and should be included with each pull request. | ||
|
||
## Coding conventions | ||
|
||
- Following the [eslint:recommended](https://eslint.org/docs/rules/) code style. | ||
- Use of [prettier](https://prettier.io/) for code formatting. | ||
- Use of [JsDocs](https://devhints.io/jsdoc) is encouraged for documentation of new features under the descretion of pull request reviewers. |