-
Notifications
You must be signed in to change notification settings - Fork 4
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
Draft
namrata93
wants to merge
10
commits into
main
Choose a base branch
from
contributing_md
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from 7 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
d9597e3
first pass at contributing.md file
namrata93 dd31659
fix
namrata93 9f3de83
Merge branch 'main' of github.com:frontapp/front-ui-kit into contribu…
namrata93 381e9c8
Fix
namrata93 f0d7a04
Fix
namrata93 6d56062
Fix
namrata93 b766065
chore: update line on testing new component in different browsers
namrata93 38636e9
docs: add new section for proposing new components
namrata93 3b66c98
chore: add a space between sections'
namrata93 81970fb
Merge branch 'main' of github.com:frontapp/front-ui-kit into contribu…
namrata93 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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,44 @@ | ||
# Code of Conduct (TODO) | ||
|
||
# Open Development (TODO) | ||
|
||
All work on this library will be done via Github. Owners of this repository as well as external developers will have to submit PRs which would have to be reviewed and approved by one of the owners before it is merged into the main branch. | ||
|
||
# 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. | ||
|
||
# Bugs (TODO) | ||
|
||
(Reporting broken changes, proposing new changes) | ||
|
||
# Contributing to front-ui-kit (TODO) | ||
|
||
## Contributor License Agreement (TODO) | ||
|
||
## Prerequisites (TODO) | ||
|
||
## Development Process (TODO) | ||
|
||
## Automated Releasing (TODO) | ||
|
||
Releases will be automated using [Release Please](https://github.com/googleapis/release-please). This will require PR's to be submitted in a specific format to match the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format. Please read through these guidelines to understand how to construct your PR. | ||
|
||
## Submitting your first PR (TODO) | ||
|
||
Base requirements for each PR | ||
1. Each PR should be submitted to merge directly into the main branch. | ||
2. The title of the PR should match the format specified in [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). | ||
3. The description includes a thorough explanation of the PR and ideally some screenshots/videos of the fix. For example, if you are adding a new component please include the component name, a description of each prop as well as any helpful videos/images from Storybook which accurately demostrates the use of the component. For any bug fixes, please include a thorough description of the bug as well as the fix (and any helpful images/videos). | ||
|
||
# Definition of Done | ||
|
||
Each component created will have to meet the following requirements to be marked as done. | ||
[This will be initially used only by Front developers while we build the starter components for this project. When we open this project for other developers to contribute, this set of requirements will likely grow.] | ||
|
||
1. Each PR for a new component should follow the guidelines highlighted above in order to be considered for review. | ||
2. Each new component should be readable and easy to understand with well defined and documented props. | ||
3. The component should be tested on different browsers to detect any browser compatibility issues. | ||
4. Each component should have its own story in Storbybook which should test the range of props supported by the component. | ||
5. The component should be approved by at least one owner of the front-ui-kit repository. | ||
6. The documentation for each new component should be clear and concise. |
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.
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.
Would not be needed since this library will not be available until 1.0.0 (publically).