diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4e60a8c5..d95ea6a3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -44,7 +44,9 @@ The general flow for making a change to the script host is: ## Deployment -🚀 Once your Pull Request has been approved, your changes will get deployed to production automatically +🚀 Once your Pull Request has been approved and merged to ```staging``` branch, your changes will get deployed to Staging site automatically + +🚀 Once you are happy with the changes on Staging site, merge ```staging``` to ```main``` branch and your changes in Staging will get deployed to Production site automatically ## Running the Project diff --git a/README.md b/README.md index 10bedef4..529a8582 100644 --- a/README.md +++ b/README.md @@ -75,6 +75,18 @@ jobs: ## To start developing CodeAuditor: We always welcome contributions. If you are interested in contributing, please take a look at our [CONTRIBUTING](./CONTRIBUTING.md) guide +### Table of Content + +1. [General](CONTRIBUTING.md#General) +2. [System Pre-reqs](CONTRIBUTING.md#system-pre-reqs) +3. [Required Tools](CONTRIBUTING.md#required-tools) +4. [Change flow](CONTRIBUTING.md#change-flow) +5. [Definition of Done](CONTRIBUTING.md#definition-of-done) +6. [Deployment](CONTRIBUTING.md#Deployment) +7. [Running the Project](CONTRIBUTING.md#Running-the-Project) +8. [Testing your changes locally](CONTRIBUTING.md#Testing-your-changes-locally) +8. [Adding your own custom HTML rule](CONTRIBUTING.md#Adding-your-own-custom-HTML-rule) + ## Technologies used in CodeAuditor ### Front End: