chore: add guidelines for open source contribution (#118)

* chore: add guidelines for open source contribution
- Add PR & issue templates
- Add contributing guidelines

* chore: fixed typo

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,33 @@
+---
+name: "🐜 Bug report"
+about: Report a bug in World Chain Contracts
+labels: bug
+---
+
+**📃 Description**
+
+<!-- Briefly describe the issue you're experiencing. Tell us what you were trying to do and what happened instead. -->
+
+**📝 Details**
+<!-- Describe the problem you have been experiencing in more detail. Include as much information as you think is relevant. Keep in mind that transactions can fail for many reasons; context is key here. -->
+
+**🔢 How to reproduce**
+<!-- Steps to reproduce the behavior:
+
+optional: 
+Code to reproduce bug
+We will be able to better help if you provide a minimal example that triggers the bug. -->
+
+**☀️ Expected behavior**
+<!-- A clear and concise description of what you expected to happen. -->
+
+**📎 Attachments**
+<!-- If applicable, add data, logs or screenshots to help explain your problem. -->
+
+**💻 Environment**
+<!-- 
+ - World Chain Contracts npm release version or branch and commit id
+ - The version of the other tools involved
+ - OS and its version [e.g. macOS/14.5]
+-->
+

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,14 @@
+---
+name: Feature request
+about: Suggest an idea
+labels: feature
+---
+
+**🧐 Motivation**
+<!-- Is your feature request related to a specific problem? Is it just a crazy idea? Tell us about it! -->
+
+**📝 Details**
+<!-- Please describe your feature request in detail. -->
+
+<!-- Make sure that you have reviewed the Contributor Guidelines. -->
+<!-- https://github.com/projectawakening/world-chain-contracts/blob/develop/CONTRIBUTING.md -->

.github/pull_request_template.md

@@ -0,0 +1,32 @@
+⚠️ PLEASE REMOVE THIS TEMPLATE BEFORE SUBMITTING ⚠️
+
+---
+## Pull Request template
+Please, go through these steps before you submit a PR.
+
+1. Make sure the title of the Pull Request title respects the [Conventional Commits Spec](https://www.conventionalcommits.org/en/v1.0.0/#summary):
+
+    a. Must be in the following format: `{type}({optional link to github issue}): {Description}` (e.g. `fix(#1063): Add missing config variables`, `docs: Add PR template`).
+
+    b. Type must be one of the following:
+    * **feat**: A new feature
+    * **improvement**: A feature improvement
+    * **fix**: A bug fix
+    * **docs**: Documentation only changes
+    * **perf**: A code change that improves performance
+    * **build**: Changes that affect the build system or external dependencies (example scopes: pnpm, yarn)
+    * **ci**: Changes to our CI configuration files and scripts
+    * **refactor**: A code change that neither fixes a bug nor adds a feature
+    * **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
+    * **test**: Adding missing tests or correcting existing tests
+    * **chore**: Improving the code base so that it can be worked with more easily
+
+    c. Please write a clear PR description (what, why and how) for your changes. Attach a link to a github issue if there is one.
+
+2. If your Pull Request includes breaking changes:
+
+    a. Add `!` in your PR title after the type. (e.g. `feat!: Upgrade entity_record tables`) or 
+
+    b. Add `BREAKING CHANGE: {Description of the breaking change}` in your PR description. (e.g. `Upgrade entity_record tables`)
+
+⚠️ PLEASE REMOVE THIS TEMPLATE BEFORE SUBMITTING ⚠️

CONTRIBUTING.md

@@ -0,0 +1,27 @@
+# Contributing Guidelines
+
+There are many ways to contribute to World Chain Contracts.
+
+## Troubleshooting
+
+You can help other users in the community to solve their issues in the [Discord].
+
+[Discord]: https://discord.com/invite/projectawakening
+
+## Opening an issue
+
+You can [open an issue] to suggest a feature or report a minor bug.
+
+Before opening an issue, be sure to search through the existing open and closed issues, and consider posting a comment in one of those instead.
+
+When requesting a new feature, include as many details as you can, especially around the use cases that motivate it. Features are prioritized according to the impact they may have on the ecosystem, so we appreciate information showing that the impact could be high.
+
+[open an issue]: https://github.com/projectawakening/world-chain-contracts/issues/choose
+
+## Submitting a pull request
+
+If you would like to contribute code or documentation you may do so by forking the repository and submitting a pull request.
+
+Make sure to read and follow the [engineering guidelines](./GUIDELINES.md). Run linter and tests to make sure your pull request is good before submitting it.
+
+When opening the pull request you will be presented with a template and a series of instructions. Read through it carefully and follow all the steps. Expect a review and feedback from the maintainers afterwards.

README.md

@@ -59,5 +59,8 @@ We are running the anvil node explicitly ourselves for three reasons:
 - Decoupling from MUD's opinionated dev tools
 - Having a stand alone development node allows us to deploy modules in a deterministic an selective manner
 
+# Contribute
+We'd love your support! There are many ways you can participate and help build. Check out the [contribution guide](CONTRIBUTING.md)!
+
 # License 
 The contents of this repository are open-source software under the [MIT license](./LICENSE).