Thank you for your interest in contributing to the Virtual Processor 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 1st of March. However, your contributions are valuable for the success of the project during this period.
-
Fork the repository to your GitHub account.
-
Clone the forked repository to your local machine:
- [your-folder] = The location of your clone.
git clone https://github.com/algosup/2023-2024-project-3-virtual-processor-team-2.git cd [your-folder] -
Set Up iat2 on your local machine. Ensure that you can build and run the project locally.
- Create a new branch for each feature, bug fix, or improvement. Use a descriptive branch name:
git checkout -b feature/new-feature
- Follow the coding style used in the existing codebase and in the technical specifications.
- Write clear and concise commit messages. Begin your commit message with a verb in the present tense:
- Good:
Resolve performance issue in the assembler. - Bad:
Fixed stuff.
- Good:
-
Ensure that your branch is up-to-date with the main repository before submitting a pull request:
git pull origin main
-
Open a pull request with a clear title and description. Reference any related issues in the description.
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.
Thank you for your contribution! Your efforts are valuable to the success of our project during this academic period. If you have any questions, feel free to reach out to us. Happy coding!