Skip to content

Latest commit

 

History

History
54 lines (33 loc) · 2.19 KB

CONTRIBUTING.md

File metadata and controls

54 lines (33 loc) · 2.19 KB
Raw

Contributing to the Project

Thank you for considering contributing to the Project! We are happy to welcome contributions from anyone interested in improving this project. Before you start, please read this guide to understand how you can contribute effectively.

How to Contribute

  1. Fork the Repository: First, fork this repository to your own account.

  2. Clone the Repository: Clone the forked repository to your local development environment.

    git clone https://github.com/Unicamp-Odhin/SPI-Slave.git

  3. Create a Branch: Create a branch for your contribution. Be sure to choose a descriptive name.

    git checkout -b my-contribution

  4. Make Changes: Make the necessary changes to the code.

  5. Test Changes: Ensure that your changes do not cause issues in the project. Run relevant tests if applicable.

  6. Commit and Push: Commit your changes and push them to your forked repository.

    git commit -m "Added a new feature"
git push origin my-contribution

  7. Create a Pull Request: Open a Pull Request (PR) to the main branch of the original project. Be sure to clearly describe the changes you made and provide relevant information.

  8. Review and Discussion: The project team will review your PR and may request changes or clarifications. Be prepared to collaborate and adjust your code as needed.

  9. Approval and Merge: After a successful review and approval by the team, your PR will be merged into the main project.

  10. Celebrate: Congratulations! Your contribution has been successfully merged.

Contribution Guidelines

  • Follow the project's coding standards.
  • Keep commit messages clear and concise.
  • Avoid making too many changes in a single PR.
  • If you are adding a new feature, consider including appropriate tests.

Communication

  • If you have questions or need help, create an issue in this repository.
  • We appreciate your contribution to making the Project better!

License

By contributing to this project, you agree that your contributions will be licensed under the same license as the project. Read the license for more details.