Add Contributing Guidelines

CONTRIBUTING.md

@@ -0,0 +1,123 @@
+# Contributing Guidelines
+
+You can contribute to the University of Adelaide Computer Science Club (CS Club) website with issues, PRs, and testing of PRs. We appreciate your efforts to make our website better.
+
+## Reporting Issues 
+
+We always welcome bug reports, feature requests and overall feedback. Here are a few tips on how you can make an effective issue report.
+
+### Finding Existing Issues
+
+Before creating a new issue, please search our [open issues](https://github.com/compsci-adl/website/issues) to check if it already exists. If you do find an existing issue, please add your own feedback in the discussion.
+
+### Writing a Good Bug Report
+
+Writing good bug reports make it easier for maintainers to verify and identify the root cause of the problem. The better the bug report, the faster the problem can be resolved. A bug report should contain the following information:
+
+- **Description of the Bug**: What's the issue you encountered?
+- **Reproduction Steps**: How can the issue be reproduced?
+- **Expected Behaviour**: What do you expect to happen?
+- **Information on the environment**: OS, Browser, Device
+- **Additional Notes**: Add any other notes or screenshots about the bug here.
+
+When you are ready to submit a bug report, please use the [Bug Report issue template](https://github.com/compsci-adl/website/issues/new?assignees=&labels=&projects=&template=bug-report.yml).
+
+### Writing a Good Feature Request
+
+Writing good feature requests make it easier for maintainers to understand the feature and see how it fits into the website. The better the feature request, the faster the feature can be discussed and possibly implemented. A feature request should contain the following information:
+
+- **Overview**: Include the basic, high-level concepts for this feature here.
+- **Details**: These may include specific methods of implementation, design considerations, or any other technical details.
+- **Why would this feature be useful?**: A clear and concise description of why this feature would improve the CS Club website.
+- **Additional Notes**: Add any other notes or screenshots about the feature request here.
+
+When you are ready to submit a request, please use the [Feature Request issue template](https://github.com/compsci-adl/website/issues/new?assignees=&labels=&projects=&template=feature-request.yml).
+
+## Contributing Changes
+
+Project maintainers will merge changes that both improve the project and meet our code quality standards. 
+
+### Suggested Workflow
+
+We recommend you to use the following workflow:
+
+1. Fork and clone the repo to your computer.
+```bash
+git clone https://github.com/YOUR_GITHUB_USERNAME/website.git
+```
+2. Create a new branch from `main` with a relevant name for a new feature or an bug you want to work on.
+```bash
+git checkout -b your-relevant-branch-name
+```
+3. Install the required packages.
+```bash
+pnpm install
+```
+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
+```
+7. Run the development server to see your changes in your browser at [http://localhost:3000](http://localhost:3000).
+```bash
+pnpm run dev
+```
+8. Push your branch.
+```bash
+git push -u origin your-relevant-branch-name
+```
+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.
+When you create a commit, please follow the convention
+`<type>[optional scope]: <description>` in your commit message while using one of
+the following categories:
+
+- `feat`: Adds a new feature
+- `fix`: Fixes a bug (please reference an
+  existing issue if present)
+- `refactor`: Restructures code while not changing its original functionality
+- `docs`: Changing existing or creating new documentation (i.e.
+  README or other markdown files)
+- `build`: Changing the build system or dependencies
+- `style`: Related to code formatting (i.e.
+  Fixing linting or Prettier errors)
+- `ci`: Changing the configuration of continuous integration (i.e.
+  Github actions)
+- `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
+<https://www.conventionalcommits.org/>.
+
+### 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.
+
+If the CI build fails for any reason, the PR actions tab should be consulted for more information on the error.
+
+### PR Feedback
+The maintainers and community members will provide feedback on your change. Community feedback is highly valued. When giving feedback, please be clear and concise.
+
+## License
+By contributing your code to the [compsci-adl/website](https://github.com/compsci-adl/website) repository, you agree to license  your contribution under the MIT License.

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-present The University of Adelaide Computer Science Club
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,23 +1,38 @@
 # CS Club Website
 
-## Development
+This is the official repository for the University of Adelaide Computer Science Club (CS Club) website. It is built using [Next.js](https://nextjs.org/), [React](https://reactjs.org/), [TypeScript](https://www.typescriptlang.org/), and [Tailwind CSS](https://tailwindcss.com/).
 
-1. Install dependencies
+## Getting Started
 
+To get started, please follow these steps: 
+1. Install the dependencies.
 ```bash
-pnpm i
+pnpm install
 ```
 
-2. Rename `.env.local.example` to `.env.local` and edit it
-
-3. Initialize database
+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.
 ```bash
 pnpm run db:push
 ```
 
-4. Run dev server
+4. Then run the development server.
 
 ```bash
 pnpm run dev
 ```
+
+Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+
+## Contributing
+
+We welcome contributions to enhance the CS Club Website! If you find any issues, have suggestions, or want to request a feature, please follow our [Contributing Guidelines](CONTRIBUTING.md).
+
+## License
+This project is licensed under the MIT License. 
+See [LICENSE](LICENSE) for details.