Create CONTRIBUTING.md #33
Open
Conversation
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
Just an initial file to resolve missing link on the Pull Request form. This file was ~~copied from~~ inspired by https://github.com/github/docs/blob/main/CONTRIBUTING.md
edwardtfn
added
the
norelease
11 tasks
avataar
reviewed
Apr 17, 2023
| - [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow) | ||
| - [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests) | ||
|
|
||
|
|
There was a problem hiding this comment.
It would be nice to have a section here on building the project. Mentioning that the project is built with yarn and not npm and a list of the available scripts:
- yarn build
- yarn test
- yarn lint
- yarn dev
MrBartusek
reviewed
Apr 17, 2023
There was a problem hiding this comment.
This guide is very basic and doesn't really help with the setup of the project, which is probably a most important element of such a guide. I've made one guide for my Lovelace card here https://github.com/MrBartusek/MeteoalarmCard/blob/master/CONTRIBUTING.md you can take inspiration from that
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Just an initial file to resolve missing link on the Pull Request form. This file was
copied frominspired by https://github.com/github/docs/blob/main/CONTRIBUTING.mdPull Request Template for Home Assistant / Lovelace Card Repository
Overview
Please provide a brief description of the changes introduced in this pull request. Include any context that will help reviewers understand the motivation behind the changes, such as the problem you are trying to solve or the feature you are implementing.
Type of Change
Checklist
Please ensure that you have completed the following tasks before submitting your pull request:
devbranch (or another appropriate branch) and verified that they are working as expected.Related Issues / Pull Requests
Please include any related issues or pull requests that this change is associated with, and use the appropriate keywords (
Closes,Fixes,Resolves) to automatically close the related issues when this pull request is merged.Additional Details
Please provide any additional information that you feel is relevant to this pull request, such as screenshots, code snippets, or examples.