Flesh out README

README.md

@@ -0,0 +1 @@
+./docs/README.md

backend/package.json

@@ -3,6 +3,7 @@
   "version": "0.1.0",
   "description": "RESTful API for Carleton Web Dev Club",
   "main": "index.js",
+  "license": "GPL-3.0-or-later",
   "scripts": {
     "start": "npm run start:server",
     "start:server": "node -r esm server.js",

docs/README.md

@@ -1,5 +1,28 @@
-# Carleton Web Dev Club Site
+# Carleton Web Dev Club
 
-## 🚧 Work in progress 🚧
+Welcome! Whether you're here to learn, to contribute, or to complain, we're happy to help!
 
-Latest contribution `docs` coming soon!
+## About
+
+This project is running express [x] and react [y] on node [z], with a mongodb [a] database using Docker.
+If you want to get a local copy up and running ASAP, please see the \*WIP* [getting started guide](/).
+
+For clarity and ease of use, the repository is structured:
+- docs in [/docs](/docs)
+- front-end code in [/frontend](/frontend)
+- back-end and db code in [/backend](/backend)
+
+## Contribution
+
+No matter your background or proficiency, we'd love your input!
+If you find a bug or some odd behaviour in the site, please open an issue using the
+[template](https://github.com/Carleton-Web-Dev-Club/club-site/issues/new?assignees=&labels=&template=bug_report.md).
+
+If you're interested in contributing features or code, please review the
+[feature request template](https://github.com/Carleton-Web-Dev-Club/club-site/issues/new?assignees=&labels=&template=feature_request.md) and \*WIP* [styleguide](/).
+It's A-OK if you need help with some of the nitty-gritty details too; we'll try our best to give quality feedback on
+pull requests, if they're not quite ready to merge :)
+
+## License
+
+The Carleton Web Developer Club Website is licensed under TBD. For the full license text, please see: [LICENSE.md](/)

docs/_coverpage.md

@@ -6,4 +6,4 @@
 - Open Source
 
 [GitHub](https://github.com/Carleton-Web-Dev-Club/club-site)
-[Get Started](#carleton-web-dev-club-site)
+[Get Started](#carleton-web-dev-club)

docs/getting-started/contributing.md

@@ -3,3 +3,38 @@
 If you would like to help, join the Discord Channel [#club-site-apigroup](https://discord.gg/8pJS4zk)
 
 Basic API specifications are given in [@Carleton-Web-Dev-Club/CWDC-Wiki](https://github.com/Carleton-Web-Dev-Club/CWDC-Wiki/blob/master/api/discussion.adoc)
+
+## Project Structure
+```
+.
+├── README.md
+├── .vscode
+├── backend    <-- API
+├── frontend   <-- React App
+├── docs       <-- Documentation Site
+├── package-lock.json
+└── package.json
+```
+
+## Coding Guidelines
+
+### Linting
+`frontend` and `backend` use ESLint. 
+> ESLint is a tool for identifying and reporting on patterns found in ECMAScript/JavaScript code, with the goal of making code more consistent and avoiding bugs.
+
+We use [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript) for ESLint. 
+
+Overrides done to base airbnb config:
+- `frontend`
+  - `react/jsx-filename-extension`: Since this is a react site we should be able to write JSX in in non `.jsx` files
+
+
+### Commits
+
+To use tooling that will make it easy to generate changelogs and automated release and enforce good standards we use [commitlint](https://commitlint.js.org/#/) that runs as a [git hook](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks) using [husky](https://typicode.github.io/husky/#/). This allows us standardize commit messages which are human readable and machines can also understand meaning.
+
+Commitlint uses [conventional commit messages](https://www.conventionalcommits.org/en/v1.0.0/). Since this spec dovetails with [SemVer](https://semver.org) which is also followed for release cycle. 
+
+We use [`@commitlint/config-conventional`](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional) config with some defined scopes and types because we are not using all the type enums for messages. Another custom rule is to allow for long body since base config restricts to 100 characters and that is not enough at times for commit body.
+
+For commit message examples and more details please read docs for [conventional commit messages](https://www.conventionalcommits.org/en/v1.0.0/) because they go in detail.

frontend/package.json

@@ -2,6 +2,7 @@
   "name": "club-site-frontend",
   "version": "0.1.0",
   "main": "index.js",
+  "license": "GPL-3.0-or-later",
   "scripts": {
     "start": "run-p -l start:*",
     "start:webpack": "webpack --mode development",

package.json

@@ -13,6 +13,7 @@
     "lint": "run-p -l lint:*",
     "docs": "docsify serve docs"
   },
+  "license": "GPL-3.0-or-later",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/Carleton-Web-Dev-Club/club-site.git"