-
Notifications
You must be signed in to change notification settings - Fork 6
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: add CONTRIBUTING.md [WIP] #7
base: main
Are you sure you want to change the base?
Conversation
👋 Is this ready? The title says WIP but you have marked this PR as ready for review. Ideally this would be a little more fleshed out and more added to it. You can look at other open source repos and see what they have in their contributing.md docs. Examples:
If this is done, can you add sections that need to be fleshed out? Also add some description to this PR explaining things and reasonings behind things. |
No no not ready. It automatically added reviewers when I created the PR. Will convert it into a draft for now. Still researching other contributing.md files. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Makes sense so far only 1 minor comment. We should add a section (or maybe somewhere else) about proposing components. Since we are only doing a certain set of components purposely, etc.
CONTRIBUTING.md
Outdated
|
||
# Semantic Versioning (TODO) | ||
|
||
The front-ui-kit library will follow [Semantic Versioning](https://semver.org/) with 0.1.0 being the first minor version in development. The first major released version will be 1.0.0 once we declare the library ready and open for development. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
with 0.1.0 being the first minor version in development. The first major released version will be 1.0.0 once we declare the library ready and open for development.
Would not be needed since this library will not be available until 1.0.0 (publically).
This PR adds the CONTRIBUTING.md file which is a contribution guide for the owners of this repository as well as future external contributors. It includes the Code of Conduct that we and other external developers should adhere by as well some instructions on how to make contributions to this repository.