From 9cd49fedba99158d77b85c53056e91249d94f262 Mon Sep 17 00:00:00 2001 From: phoenixpereira Date: Wed, 24 Jan 2024 16:46:39 +1030 Subject: [PATCH] docs: update CONTRIBUTING and README to address feedback --- CONTRIBUTING.md | 32 +++++++++++++++++++++++++------- README.md | 12 ++++++++---- 2 files changed, 33 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1f1c9595..a60dd757 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -53,22 +53,33 @@ git checkout -b your-relevant-branch-name ```bash pnpm install ``` -4. Ensure there are no linting or formatting errors in your code. +4. Set up the required keys: +- Copy `.env.local.example` to a new file `.env.local`. +- Create a [Clerk](https://clerk.com) account and make a new application within the Clerk dashboard. +- Configure the settings to require a name, reject compromised passwords, and enforce average strength passwords. +- Copy the keys to `.env.local`. + +5. Initialise the database. +```bash +pnpm run db:push +``` + +6. Ensure there are no linting or formatting errors in your code. ```bash pnpm run lint pnpm run format ``` -5. Run the development server to see your changes in action. +7. Run the development server to see your changes in your browser at [http://localhost:3000](http://localhost:3000). ```bash pnpm run dev ``` -6. Push your branch. +8. Push your branch. ```bash git push -u origin your-relevant-branch-name ``` -7. Once you are happy with your changes, create a pull request (PR) with a relevant title and description to merge your changes into the [compsci-adl/website](https://github.com/compsci-adl/website) repository's `main` branch. -8. Wait for feedback and approval of your changes from the maintainers -9. When the maintainers have signed off, all checks are green, and there are no merge conflicts, your PR will be merged. +9. Once you are happy with your changes, create a pull request (PR) with a relevant title and description to merge your changes into the [compsci-adl/website](https://github.com/compsci-adl/website) repository's `main` branch. +10. Wait for feedback and approval of your changes from the maintainers +11. When the maintainers have signed off, all checks are green, and there are no merge conflicts, your PR will be merged. ### Commit Messages Before you create a PR, please check whether your commits comply with the commit conventions used for this repository. @@ -90,8 +101,15 @@ the following categories: - `chore`: Changes that do not fit into any of the above categories +For example: +``` +feat(db): Add database schema + +ci: Add prettier to CI workflow +``` + If you are interested in the detailed specification you can visit - +. ### PR - CI Process Automatic tests will be performed for PRs. Builds and test runs must not contain errors or have bugs properly filed against unexpected errors that are unrelated to your change. diff --git a/README.md b/README.md index e50a8d12..63f97939 100644 --- a/README.md +++ b/README.md @@ -7,17 +7,21 @@ This is the official repository for the University of Adelaide Computer Science To get started, please follow these steps: 1. Install the dependencies. ```bash -pnpm i +pnpm install ``` -2. Set up the keys by copying `.env.local.example` to a new file `.env.local` and replace the placeholder keys with the actual keys. Please contact the open source officers on the CS Club Discord to get these keys. +2. Set up the required keys: +- Copy `.env.local.example` to a new file `.env.local`. +- Create a [Clerk](https://clerk.com) account and make a new application within the Clerk dashboard. +- Configure the settings to require a name, reject compromised passwords, and enforce average strength passwords. +- Copy the keys to `.env.local`. -3. Initialise the database +3. Initialise the database. ```bash pnpm run db:push ``` -4. Then run the development server +4. Then run the development server. ```bash pnpm run dev