Skip to content
This repository was archived by the owner on Jan 24, 2023. It is now read-only.

Commit c5f7810

Browse files
authored
Automation Update + README (#6)
* new deployment strat * removed old workflow * new README format
1 parent b877728 commit c5f7810

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Welcome to Code Quantums Repository!
2+
3+
We are dedicated to being an open source organization and our website is no exception!
4+
We look forward to our first Hackathon with everyone!! ✨
5+
6+
# Managing our repository
7+
8+
It is every contributors' responsibility to ensure that a clean working environment is maintained. This allows others to work and utilize to space to better perform and develop on our growing code bases!
9+
10+
## Current Workflows
11+
12+
- `main` deploys to [codequantumutsa.com](http://codequantumutsa.com)
13+
- `develop` deploys to [dev.codequantumutsa.com](http://dev.codequantumutsa.com)
14+
15+
## Submitting a Change
16+
17+
- pushing to `main` is restricted
18+
- make sure you have any recent changes to `develop`
19+
- create a new branch from `develop` and push that new branch
20+
- create a pull request for the new branch into `develop`
21+
- if all approved we will be doing weekly merges into `main`
22+
23+
## Branch Naming
24+
25+
Adding something new:
26+
```
27+
feature/SHORT_DESCRIPTION_OF_FEATURE_HERE
28+
```
29+
30+
Submitting a bug/error change:
31+
```
32+
bug/SHORT_DESCRIPTION_OF_BUG_HERE
33+
```
34+
- please note that once your branch is merged it *should* be deleted!
35+
- restrictions have hopefully been placed on the `develop` and `main` branches so that they cannot be deleted!
36+
37+
# Contact Us!
38+
39+
Have a question that cannot be answered here?
40+
41+
- [team@codequantumutsa.org](mailto:team@codequantumutsa.org)
42+
43+
- [team@acmutsa.org](mailto:team@acmutsa.org)

0 commit comments

Comments
 (0)