Skip to content

Latest commit

 

History

History
70 lines (41 loc) · 2.8 KB

CONTRIBUTING.md

File metadata and controls

70 lines (41 loc) · 2.8 KB
Raw

Contribution Guide

Thank you for considering contributing to the "Vex Code Snippets" project! Contributions are highly appreciated, as they help improve the project and make it more valuable for the community. To ensure a smooth and collaborative contribution process, please follow the guidelines outlined below:

Code of Conduct

Before diving into the contribution process, please review and abide by the project's Code of Conduct. We aim to foster an inclusive and welcoming environment for everyone involved.

Ways to Contribute

There are several ways you can contribute to the project:

  1. Code Contributions: You can contribute by adding new code snippets, improving existing code, fixing bugs, or optimizing performance. Feel free to fork the repository, make your changes, and submit a pull request.

  2. Documentation: Help improve the documentation by correcting errors, adding more clarity, or providing additional examples.

  3. Issue Reporting: If you come across any issues or bugs, please open an issue on the project's GitHub repository. Provide detailed information about the problem, including steps to reproduce it.

Getting Started

To contribute to the project, follow these steps:

  1. Fork the project repository to your GitHub account.

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

    git clone https://github.com/your-username/MoveForward.git

  3. Create a new branch for your contribution:

    git checkout -b my-contribution

  4. Make the necessary changes, additions, or improvements in your local repository.

  5. Commit your changes with descriptive commit messages:

    git commit -m "Add new code snippet for turning left"

  6. Push your changes to your forked repository:

    git push origin my-contribution

  7. Open a pull request on the main repository. Provide a clear and detailed description of your contribution.

  8. Wait for the project maintainers to review your pull request. Be open to any feedback or suggestions for improvement.

Code Guidelines

When contributing code to the project, please adhere to the following guidelines:

  • Follow the existing code style and formatting used in the project.
  • Write clear and concise code with appropriate comments.
  • Ensure that your code is well-documented, including any function or class descriptions.
  • Test your changes thoroughly to avoid introducing new bugs.

License

By contributing to this project, you agree that your contributions will be licensed under the Creative Commons Attribution 3.0 Unported License .

Contact

If you have any further questions or need assistance with the contribution process, feel free to reach out to the project maintainer at josue.dev@yahoo.com.