docs: Add CONTRIBUTING.md and CODE_OF_CONDUCT.md

CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community includes using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting an individual maintainer (@OXeu) at ```i@xeu.life```. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,58 @@
+# Contributing to Rin
+
+We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.
+
+# Commit-msg Hook
+We have a sample commit-msg hook in scripts/commit-msg.sh. To set it up, run:
+
+```sh
+ln -s ../../scripts/commit-msg.sh commit-msg
+```
+
+This will run following checks on staged files before each commit:
+
+1. `tsc` to check TypeScript files
+2. check if commit message is starting with one of the following: feat|chore|fix|docs|ci|style|test|pref
+
+If you want to skip the hook, run `git commit` with `--no-verify` option.
+
+# Setup Development Environment
+
+1. Fork & Clone the repository
+2. Install [Node](https://nodejs.org/en/download/package-manager) & [Bun](https://bun.sh/)
+3. Install dependencies
+```sh
+bun i
+```
+4. Copy the `wrangler.example.toml` file to `wrangler.toml` and fill in the necessary information
+5. Copy the `client/.env.example` file to `client/.env` and fill in the necessary information
+5. Start the development server
+```sh
+bun dev
+```
+6. For more control over the development server, you can run the dev command in the client directory and the server directory separately:
+```sh
+# tty1
+cd client
+bun dev
+
+# tty2
+cd server
+bun dev
+```
+
+# Submitting changes 
+
+1. Get at least one +1 on your PR before you push.
+For simple patches, it will only take a minute for someone to review it.
+
+2. Don't force push small changes after making the PR ready for review. Doing so will force readers to re-read your entire PR, which will delay the review process.
+
+3. Always keep the CI green.
+
+4. Do not push, if the CI failed on your PR. Even if you think it's not your patch's fault. Help to fix the root cause if something else has broken the CI, before pushing.
+
+*Happy Hacking!*
+
+# Code reviews
+All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.