From d9597e31de1384a189d3b23f306c85e052d73995 Mon Sep 17 00:00:00 2001 From: Namrata Prabhu Date: Thu, 28 Apr 2022 15:43:59 -0700 Subject: [PATCH 1/8] first pass at contributing.md file --- CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..dd9565d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,10 @@ +# 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. As this project is open for other developers, this set of requirements will likely grow.] + +1. Stories in Storybook: Each component's story should test the range of props supported by the component. +2. Approved by at least one other developer. +3. Documentation for the component is created / updated. +4. \ No newline at end of file From dd31659ec0b7ae8a14bc477b0796db5ff5a1a2a5 Mon Sep 17 00:00:00 2001 From: Namrata Prabhu Date: Thu, 28 Apr 2022 15:45:04 -0700 Subject: [PATCH 2/8] fix --- CONTRIBUTING.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dd9565d..defbe5f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,10 +1,8 @@ # 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. As this project is open for other developers, this set of requirements will likely grow.] +[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. Stories in Storybook: Each component's story should test the range of props supported by the component. 2. Approved by at least one other developer. -3. Documentation for the component is created / updated. -4. \ No newline at end of file +3. Documentation for the component is created / updated. \ No newline at end of file From 381e9c83ac78fd9496a9a544a753b439e85929f3 Mon Sep 17 00:00:00 2001 From: Namrata Prabhu Date: Tue, 3 May 2022 12:03:51 -0700 Subject: [PATCH 3/8] Fix --- CONTRIBUTING.md | 41 ++++++++++++++++++++++++++++++++++++++--- 1 file changed, 38 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index defbe5f..bf4e064 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,8 +1,43 @@ +# 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 PRs 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 demostrate the use of the component. + # 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. Stories in Storybook: Each component's story should test the range of props supported by the component. -2. Approved by at least one other developer. -3. Documentation for the component is created / updated. \ No newline at end of file +1. Each PR should follow the guidelines highlighted above in order to be considered for review. +2. Stories in Storybook: Each component's story should test the range of props supported by the component. +3. Each PR should be approved by at least one owner of the front-ui-kit repository. +4. Documentation for the change is created / updated to include any deprecation warnings, updated props, etc. +5. The ChangeLog is updated to describe the change along with any changes to the versioning. \ No newline at end of file From f0d7a0426cfc203887c98783564cfa2eb2d874b5 Mon Sep 17 00:00:00 2001 From: Namrata Prabhu Date: Tue, 3 May 2022 12:37:10 -0700 Subject: [PATCH 4/8] Fix --- CONTRIBUTING.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bf4e064..ee92fb7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -28,8 +28,8 @@ Releases will be automated using [Release Please](https://github.com/googleapis/ Base requirements for each PR 1. Each PR should be submitted to merge directly into the main branch. -2. The title of the PRs 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 demostrate the use of the component. +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 @@ -39,5 +39,4 @@ Each component created will have to meet the following requirements to be marked 1. Each PR should follow the guidelines highlighted above in order to be considered for review. 2. Stories in Storybook: Each component's story should test the range of props supported by the component. 3. Each PR should be approved by at least one owner of the front-ui-kit repository. -4. Documentation for the change is created / updated to include any deprecation warnings, updated props, etc. -5. The ChangeLog is updated to describe the change along with any changes to the versioning. \ No newline at end of file +4. Documentation for the change is created / updated to include any deprecation warnings, updated props, etc. \ No newline at end of file From 6d560628a5ddd14067ee03dc18599c0a9faa2f78 Mon Sep 17 00:00:00 2001 From: Namrata Prabhu Date: Tue, 3 May 2022 13:32:48 -0700 Subject: [PATCH 5/8] Fix --- CONTRIBUTING.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ee92fb7..3fd8804 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -36,7 +36,9 @@ Base requirements for each PR 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 should follow the guidelines highlighted above in order to be considered for review. -2. Stories in Storybook: Each component's story should test the range of props supported by the component. -3. Each PR should be approved by at least one owner of the front-ui-kit repository. -4. Documentation for the change is created / updated to include any deprecation warnings, updated props, etc. \ No newline at end of file +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 is 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. \ No newline at end of file From b766065b61c192758accf9a2b1c6fb1155bb2544 Mon Sep 17 00:00:00 2001 From: Namrata Prabhu Date: Tue, 3 May 2022 13:48:08 -0700 Subject: [PATCH 6/8] chore: update line on testing new component in different browsers --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3fd8804..38cb931 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -38,7 +38,7 @@ Each component created will have to meet the following requirements to be marked 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 is tested on different browsers to detect any browser compatibility issues. +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. \ No newline at end of file From 38636e9308c1a4cfc48bf07882465e300dc5f366 Mon Sep 17 00:00:00 2001 From: Namrata Prabhu Date: Tue, 3 May 2022 16:08:44 -0700 Subject: [PATCH 7/8] docs: add new section for proposing new components --- CONTRIBUTING.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 38cb931..7063680 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,8 +6,7 @@ All work on this library will be done via Github. Owners of this repository as w # 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. - +The front-ui-kit library will follow [Semantic Versioning](https://semver.org/). # Bugs (TODO) (Reporting broken changes, proposing new changes) @@ -16,6 +15,10 @@ The front-ui-kit library will follow [Semantic Versioning](https://semver.org/) ## 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) From 3b66c981d7d4a10c451ac4579227c05ff8eec318 Mon Sep 17 00:00:00 2001 From: Namrata Prabhu Date: Tue, 3 May 2022 16:11:51 -0700 Subject: [PATCH 8/8] chore: add a space between sections' --- CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7063680..fb89ef5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,6 +7,7 @@ All work on this library will be done via Github. Owners of this repository as w # Semantic Versioning (TODO) The front-ui-kit library will follow [Semantic Versioning](https://semver.org/). + # Bugs (TODO) (Reporting broken changes, proposing new changes)