Skip to content
This repository has been archived by the owner on Jan 30, 2024. It is now read-only.

Commit

Permalink
docs: Add contributing guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
GeorgiosP authored Jan 6, 2020
2 parents 23f8d71 + f750146 commit 3040292
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions CONTRIBUTING.MD
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.

0 comments on commit 3040292

Please sign in to comment.