Skip to content
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
wants to merge 10 commits into
base: main
Choose a base branch
from
48 changes: 48 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# 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/).

# Bugs (TODO)

(Reporting broken changes, proposing new changes)

# Contributing to front-ui-kit (TODO)

## Contributor License Agreement (TODO)

## Proposing New Components (TODO)

If you would like to develop your own component, please first submit a proposal via a Github issue.

## 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.