diff --git a/README.md b/README.md index f62fac3..56b09b3 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,21 @@ -# CLASS-core -Curriculum development for Cloud for Researchers, A Primer +# CLASS-Essentials +This is the repository for the CLASS Essentials Curriculum material for AWS, GCP and Azure. -For development see the [build instructions](Build.md). +# Contribution Workflow +We use a `Feature` branch workflow: each user works on a specific Feature branch associated with a specific cloud provider. The core idea behind the `Feature` Branch Workflow is that all feature development should take place in a dedicated branch instead of the main branch. The Feature branches in this repository currently are `aws-dev`, `gcp-dev`, and `azure-dev`. More information can be found on [this Atlassian page](https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow). + +Best Practices: +1. Do not edit directly in a branch that you did not create. Use Github issues or pull requests to suggest or request changes. +2. Make pull requests before merging to main. + +# Maintainers +[John Hicks](jhicks@internet2.edu) + +[Tim Middlekoop](tmiddelkoop@internet2.edu) + +[Ananya Ravipati](aravipati@internet2.edu) + +[Amanda Tan](atan@internet2.edu) + +# License +Creative Commons License
This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.