Merge pull request #57 from algosup/contributing

Add CONTRIBUTING to main

CONTRIBUTING.md

@@ -0,0 +1,51 @@
+# Contributing Guidelines
+
+Thank you for your interest in contributing to the Pac-Man project! This project is a school assignment with a specific deadline, so we appreciate your understanding that we won't be maintaining this project beyond the current academic period, which ends on the 22nd of December. However, your contributions are valuable for the success of the project during this period.
+
+## Getting Started
+
+1. **Fork the repository to your GitHub account.**
+
+2. **Clone the forked repository to your local machine:**
+    ```bash
+    git clone https://github.com/your-username/pacman-assembly
+    cd pacman-assembly
+    ```
+
+3. **Set up DOSBox and NASM on your local machine. Ensure that you can build and run the Pac-Man project locally.**
+
+## Making Contributions
+
+### Branching Strategy
+
+- Create a new branch for each feature, bug fix, or improvement. Use a descriptive branch name:
+    ```bash
+    git checkout -b feature/new-feature
+    ```
+
+### Code Style
+
+- Follow the coding style used in the existing codebase and in the technical specifications.
+
+### Commit Messages
+
+- Write clear and concise commit messages. Begin your commit message with a verb in the present tense:
+    - **Good**: `Add player movement functionality`
+    - **Bad**: `Added stuff`
+
+### Pull Requests
+
+- Ensure that your branch is up-to-date with the main repository before submitting a pull request:
+    ```bash
+    git pull origin main
+    ```
+
+- Open a pull request with a clear title and description. Reference any related issues in the description.
+
+## Reporting Issues
+
+If you encounter any issues or have suggestions for improvement, please feel free to open an issue. Be sure to provide detailed information about the problem or your proposed enhancement.
+
+## Conclusion
+
+Thank you for your contribution! Your efforts are valuable to the success of our Pac-Man project during this academic period. If you have any questions, feel free to reach out to us. Happy coding!