Skip to content

Commit ca65526

Browse files
committed
Update README and CONTRIBUTING
1 parent 2447ddc commit ca65526

File tree

2 files changed

+15
-1
lines changed

2 files changed

+15
-1
lines changed

CONTRIBUTING.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,9 @@ The general flow for making a change to the script host is:
4444
4545
## Deployment
4646

47-
🚀 Once your Pull Request has been approved, your changes will get deployed to production automatically
47+
🚀 Once your Pull Request has been approved and merged to ```staging``` branch, your changes will get deployed to Staging site automatically
48+
49+
🚀 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
4850

4951
## Running the Project
5052

README.md

+12
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,18 @@ jobs:
7575
## To start developing CodeAuditor:
7676
We always welcome contributions. If you are interested in contributing, please take a look at our [CONTRIBUTING](./CONTRIBUTING.md) guide
7777
78+
### Table of Content
79+
80+
1. [General](CONTRIBUTING.md#General)
81+
2. [System Pre-reqs](CONTRIBUTING.md#system-pre-reqs)
82+
3. [Required Tools](CONTRIBUTING.md#required-tools)
83+
4. [Change flow](CONTRIBUTING.md#change-flow)
84+
5. [Definition of Done](CONTRIBUTING.md#definition-of-done)
85+
6. [Deployment](CONTRIBUTING.md#Deployment)
86+
7. [Running the Project](CONTRIBUTING.md#Running-the-Project)
87+
8. [Testing your changes locally](CONTRIBUTING.md#Testing-your-changes-locally)
88+
8. [Adding your own custom HTML rule](CONTRIBUTING.md#Adding-your-own-custom-HTML-rule)
89+
7890
## Technologies used in CodeAuditor
7991
8092
### Front End:

0 commit comments

Comments
 (0)