Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Ipstenu committed Mar 18, 2024
1 parent 62cd4a4 commit a1323d1
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,14 @@ It's recommended to use [Homebrew](https://brew.sh) on macOS or [Chocolatey](htt

## Contributing

All code must pass through the `development` branch which is kept up tp date. As such, any pull requests should be made to **development**, which will push the code automatically to our development server for testing.
All code must pass through the `development` branch for testing. As such, any pull requests should be made to both **production** and **development**, which will push the code automatically to the appropriate server.

1. Using the `development` branch as base, create a new branch with a descriptive name like `fixing-charts` or `fix/chartjs421` or `feature/latest-posts` . Commit your work to that branch until it's ready for full testing
2. Open [a pull request](https://help.github.com/en/desktop/contributing-to-projects/creating-a-pull-request) from your feature branch to the `development` branch.
1. Using the `production` branch as base, create a new branch with a descriptive name like `fixing-charts` or `fix/chartjs421` or `feature/latest-posts` . Commit your work to that branch until it's ready for full testing
2. Open [a pull request](https://help.github.com/en/desktop/contributing-to-projects/creating-a-pull-request) from your feature branch to the `production` branch.
3. Open [a pull request](https://help.github.com/en/desktop/contributing-to-projects/creating-a-pull-request) from your feature branch to the `development` branch.
3. If you are not a main developer, your pull request will be reviewed before it can be merged. If there are issues or changes needed, you may be asked to do so, or they may be done for you.
4. When the code passes review, it will be merged into the `development` branch and can be tested on the dev server.
5. Once the code passes tests, the `development` branch will be merged into `production` and the job is done!
5. Once the code passes tests, the production PR can be merged into the `production` branch, which will auto deploy.

To install and update:

Expand All @@ -38,14 +39,16 @@ To install and update:

Commits are currently not linted by default.

### CSS
### CSS & JS

If you're updating CSS you have a couple options, since it's all SCSS:

1. `grunt watch` - run grunt and leave open for ongoing changes.
2. `grunt build` - run the build process once.

### Libraries
This will also update any needed internal javascript.

### External Libraries

JS libraries are included via NPM.

Expand Down

0 comments on commit a1323d1

Please sign in to comment.