Merge pull request #47 from danielcdz/feat-add-contributing-guidelines

Add contribution guidelines

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,12 @@
+## Pull Request Overview
+### 📝 Summary 
+- Closes #(issue)
+- 
+### 🔄 Changes Made
+- 
+### 🔧 Tests Results
+- 
+
+### 🔜 Next Steps
+- 
+

CONTRIBUTION.MD

@@ -0,0 +1,46 @@
+# Contribution Guidelines
+Thank you for considering contributing to this project! We appreciate your time and effort in improving our work. Below are the guidelines to help you contribute effectively.
+
+# How to Contribute
+### 1. Fork the Repository: 
+Start by forking this repository to your GitHub account.
+
+### 2. Clone the repository:
+After forking, clone the repository to your local machine:
+``` bash
+git clone https://github.com/your-user/ByteBeastsBackend.git
+cd ByteBeastBackend
+```
+
+### 3. Create a New Branch:
+Create a new branch for your feature or bug fix follwing the branch naming convention:
+- For bugs: `bug-fix-name`
+- For new features: `feat-name`
+``` bash
+git checkout -b feature-name
+```
+
+### 4. Make Changes:
+Make your changes to the codebase. Ensure your code adheres to the project's coding style and standards. Make sure to add/update tests if needed.
+
+### 5. Run Tests:
+Before submitting your changes, run the existing test suite to ensure your code does not break anything:
+``` bash 
+sozo build
+sozo test
+```
+
+### 6. Commit Your Changes:
+Use a descriptive commit message that explains your changes clearly.
+
+### 7. Push to Your Fork:
+Push your changes to your forked repository.
+
+### 8. Submit a Pull Request
+Once your changes are ready, submit a Pull Request (PR) for review. Ensure that:
+
+- Your PR has a clear and descriptive title.
+- You provide a detailed explanation of the changes made.
+- You reference any related issues (if applicable).
+
+All contributions must go through the PR review process to maintain code quality and consistency. A project maintainer will review your PR and provide feedback or merge it into the main branch.

README.md

@@ -42,21 +42,8 @@ sozo migrate apply
 torii --world 0x70835f8344647b1e573fe7aeccbf044230089eb19624d3c7dea4080f5dcb025 --allowed-origins "*"
 ```
 
----
-
 ## Contribution
 
-This starter project is a constant work in progress and contributions are greatly appreciated!
-
-1. **Report a Bug**
-
-   - If you think you have encountered a bug, and we should know about it, feel free to report it [here](https://github.com/dojoengine/dojo-starter/issues) and we will take care of it.
-
-2. **Request a Feature**
-
-   - You can also request for a feature [here](https://github.com/dojoengine/dojo-starter/issues), and if it's viable, it will be picked for development.
-
-3. **Create a Pull Request**
-   - It can't get better then this, your pull request will be appreciated by the community.
+We welcome contributions from developers of all levels! If you're interested in contributing to this project, please follow our  [CONTRIBUTION GUIDELINES](./CONTRIBUTION.md) to get started.
 
-Happy coding!
+Whether it's fixing bugs, improving documentation, or adding new features, your help is greatly appreciated. Don't hesitate to ask questions or reach out for support—we're here to help!