diff --git a/tier0/{{cookiecutter.project_slug}}/README.md b/tier0/{{cookiecutter.project_slug}}/README.md index 0b202cc..3993636 100644 --- a/tier0/{{cookiecutter.project_slug}}/README.md +++ b/tier0/{{cookiecutter.project_slug}}/README.md @@ -76,7 +76,7 @@ TODO: Using the "tree -d" command can be a helpful way to generate this informat TODO - Add the repo's linting and code style guidelines -Each application has its own linting and testing guidelines. Lint and code tests are run on each commit, so linters and tests should be run locally before commiting. +Each application has its own linting and testing guidelines. Lint and code tests are run on each commit, so linters and tests should be run locally before committing. --> diff --git a/tier1/{{cookiecutter.project_slug}}/README.md b/tier1/{{cookiecutter.project_slug}}/README.md index 81be898..3299893 100644 --- a/tier1/{{cookiecutter.project_slug}}/README.md +++ b/tier1/{{cookiecutter.project_slug}}/README.md @@ -38,7 +38,7 @@ TODO: Using the "tree -d" command can be a helpful way to generate this informat diff --git a/tier2/{{cookiecutter.project_slug}}/CONTRIBUTING.md b/tier2/{{cookiecutter.project_slug}}/CONTRIBUTING.md index 88e6c39..07463f4 100644 --- a/tier2/{{cookiecutter.project_slug}}/CONTRIBUTING.md +++ b/tier2/{{cookiecutter.project_slug}}/CONTRIBUTING.md @@ -55,7 +55,7 @@ TODO: Discuss where tests can be found, how they are run, and what kind of tests ### Coding Style and Linters - ## Local Development @@ -52,7 +52,7 @@ This project is monorepo with several apps. Please see the [api](./api/README.md -Each application has its own linting and testing guidelines. Lint and code tests are run on each commit, so linters and tests should be run locally before commiting. +Each application has its own linting and testing guidelines. Lint and code tests are run on each commit, so linters and tests should be run locally before committing. diff --git a/tier3/{{cookiecutter.project_slug}}/CONTRIBUTING.md b/tier3/{{cookiecutter.project_slug}}/CONTRIBUTING.md index d9d518e..49ce9b5 100644 --- a/tier3/{{cookiecutter.project_slug}}/CONTRIBUTING.md +++ b/tier3/{{cookiecutter.project_slug}}/CONTRIBUTING.md @@ -50,7 +50,7 @@ We follow the [GitHub Flow Workflow](https://guides.github.com/introduction/flow ### Coding Style and Linters - This project is governed by our [Community Guidelines](COMMUNITY_GUIDELINES.md) and [Code of Conduct](CODE_OF_CONDUCT.md). diff --git a/tier3/{{cookiecutter.project_slug}}/MAINTAINERS.md b/tier3/{{cookiecutter.project_slug}}/MAINTAINERS.md index 8f97204..db8132d 100644 --- a/tier3/{{cookiecutter.project_slug}}/MAINTAINERS.md +++ b/tier3/{{cookiecutter.project_slug}}/MAINTAINERS.md @@ -15,9 +15,9 @@ This is a list of maintainers for this project. See [CODEOWNERS.md](./CODEOWNERS | Roles | Responsibilities| Requirements | Defined by| | -------------|:---------------|:-------------|:-------------| | member | active contributor in the community | multiple contributions to the project. | PROJECT GitHub org Committer Team| -| reviewer | review contributions from other members | history of review and authorship in a subproject | MAINTAINERS file reviewer entry, and GitHub Org Triage Team| -| approver | approve accepting contributions | highly experienced and active reviewer + contributor to a subproject | MAINTAINERS file approver entry and GitHub Triage Team | -| lead | set direction and priorities for a subproject | demonstrated responsibility and excellent technical judgement for the subproject | MAINTAINERS file owner entry and GitHub Org Admin Team| +| reviewer | review contributions from other members | history of review and authorship in a sub-project | MAINTAINERS file reviewer entry, and GitHub Org Triage Team| +| approver | approve accepting contributions | highly experienced and active reviewer + contributor to a sub-project | MAINTAINERS file approver entry and GitHub Triage Team | +| lead | set direction and priorities for a sub-project | demonstrated responsibility and excellent technical judgement for the sub-project | MAINTAINERS file owner entry and GitHub Org Admin Team| ## Contributors diff --git a/tier3/{{cookiecutter.project_slug}}/README.md b/tier3/{{cookiecutter.project_slug}}/README.md index 78f7c42..0fbc89f 100644 --- a/tier3/{{cookiecutter.project_slug}}/README.md +++ b/tier3/{{cookiecutter.project_slug}}/README.md @@ -38,7 +38,7 @@ An up-to-date list of core team members can be found in [MAINTAINERS.md](MAINTAI # Development and Software Delivery Lifecycle -The following guide is for members of the project team who have access to the repository as well as code contributors. The main difference between internal and external contributions is that external contributors will need to fork the project and will not be able to merge their own pull requests. For more information on contribributing, see: [CONTRIBUTING.md](./CONTRIBUTING.md). +The following guide is for members of the project team who have access to the repository as well as code contributors. The main difference between internal and external contributions is that external contributors will need to fork the project and will not be able to merge their own pull requests. For more information on contributing, see: [CONTRIBUTING.md](./CONTRIBUTING.md). ## Local Development @@ -50,7 +50,7 @@ This project is monorepo with several apps. Please see the [api](./api/README.md -Each application has its own linting and testing guidelines. Lint and code tests are run on each commit, so linters and tests should be run locally before commiting. +Each application has its own linting and testing guidelines. Lint and code tests are run on each commit, so linters and tests should be run locally before committing. ## Branching Model @@ -63,7 +63,7 @@ This project follows [trunk-based development](https://trunkbaseddevelopment.com * Ticket any unfinished or partially finished work. * Tests should be written for changes introduced, and adhere to the text percentage threshold determined by the project. -This project uses **continuous deployment** using [Github Actions](https://github.com/features/actions) which is configured in the [./github/worfklows](.github/workflows) directory. +This project uses **continuous deployment** using [Github Actions](https://github.com/features/actions) which is configured in the [./github/workflows](.github/workflows) directory. Pull-requests are merged to `main` and the changes are immediately deployed to the development environment. Releases are created to push changes to production. --> diff --git a/tier4/{{cookiecutter.project_slug}}/CONTRIBUTING.md b/tier4/{{cookiecutter.project_slug}}/CONTRIBUTING.md index 9fececf..a18a4ef 100644 --- a/tier4/{{cookiecutter.project_slug}}/CONTRIBUTING.md +++ b/tier4/{{cookiecutter.project_slug}}/CONTRIBUTING.md @@ -50,7 +50,7 @@ We follow the [GitHub Flow Workflow](https://guides.github.com/introduction/flow ### Coding Style and Linters - This project is governed by our [Community Guidelines](COMMUNITY_GUIDELINES.md) and [Code of Conduct](CODE_OF_CONDUCT.md). diff --git a/tier4/{{cookiecutter.project_slug}}/MAINTAINERS.md b/tier4/{{cookiecutter.project_slug}}/MAINTAINERS.md index 8f97204..db8132d 100644 --- a/tier4/{{cookiecutter.project_slug}}/MAINTAINERS.md +++ b/tier4/{{cookiecutter.project_slug}}/MAINTAINERS.md @@ -15,9 +15,9 @@ This is a list of maintainers for this project. See [CODEOWNERS.md](./CODEOWNERS | Roles | Responsibilities| Requirements | Defined by| | -------------|:---------------|:-------------|:-------------| | member | active contributor in the community | multiple contributions to the project. | PROJECT GitHub org Committer Team| -| reviewer | review contributions from other members | history of review and authorship in a subproject | MAINTAINERS file reviewer entry, and GitHub Org Triage Team| -| approver | approve accepting contributions | highly experienced and active reviewer + contributor to a subproject | MAINTAINERS file approver entry and GitHub Triage Team | -| lead | set direction and priorities for a subproject | demonstrated responsibility and excellent technical judgement for the subproject | MAINTAINERS file owner entry and GitHub Org Admin Team| +| reviewer | review contributions from other members | history of review and authorship in a sub-project | MAINTAINERS file reviewer entry, and GitHub Org Triage Team| +| approver | approve accepting contributions | highly experienced and active reviewer + contributor to a sub-project | MAINTAINERS file approver entry and GitHub Triage Team | +| lead | set direction and priorities for a sub-project | demonstrated responsibility and excellent technical judgement for the sub-project | MAINTAINERS file owner entry and GitHub Org Admin Team| ## Contributors diff --git a/tier4/{{cookiecutter.project_slug}}/README.md b/tier4/{{cookiecutter.project_slug}}/README.md index e192726..dd050e6 100644 --- a/tier4/{{cookiecutter.project_slug}}/README.md +++ b/tier4/{{cookiecutter.project_slug}}/README.md @@ -30,7 +30,7 @@ An up-to-date list of core team members can be found in [MAINTAINERS.md](MAINTAI # Development and Software Delivery Lifecycle -The following guide is for members of the project team who have access to the repository as well as code contributors. The main difference between internal and external contributions is that external contributors will need to fork the project and will not be able to merge their own pull requests. For more information on contribributing, see: [CONTRIBUTING.md](./CONTRIBUTING.md). +The following guide is for members of the project team who have access to the repository as well as code contributors. The main difference between internal and external contributions is that external contributors will need to fork the project and will not be able to merge their own pull requests. For more information on contributing, see: [CONTRIBUTING.md](./CONTRIBUTING.md). ## Local Development @@ -54,7 +54,7 @@ This project follows [trunk-based development](https://trunkbaseddevelopment.com * Ticket any unfinished or partially finished work. * Tests should be written for changes introduced, and adhere to the text percentage threshold determined by the project. -This project uses **continuous deployment** using [Github Actions](https://github.com/features/actions) which is configured in the [./github/worfklows](.github/workflows) directory. +This project uses **continuous deployment** using [Github Actions](https://github.com/features/actions) which is configured in the [./github/workflows](.github/workflows) directory. Pull-requests are merged to `main` and the changes are immediately deployed to the development environment. Releases are created to push changes to production. -->