Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
68 lines (49 loc) · 2.67 KB

CONTRIBUTING.md

File metadata and controls

68 lines (49 loc) · 2.67 KB

Contributing to the Path Planner FRC for FLL

Thank you for your interest in contributing to this project! Your contribution is essential for improving the tool and supporting FLL teams in creating trajectories for SPIKE Prime robots.

🛠 How to Contribute

To start contributing, follow the steps below:

  1. Fork this repository to your GitHub account.
  2. Clone the repository to your local machine: 
    git clone https://github.com/meuNobre/Path-Planner-FRC-for-FLL.git
  3. Create a branch with a descriptive name for your feature or fix. Examples of branch names:
    • feature/pure-pursuit to add the Pure Pursuit algorithm.
    • bugfix/sensor-adjustment to fix issues with sensors.
    • improvement/code-refactor for code refactoring or improvements.
    git checkout -b feature/your-feature-name
  4. Make your changes and commit with a clear message: 
    git commit -m "Add support for Pure Pursuit algorithm"
  5. Push your changes to your fork: 
    git push origin feature/pure-pursuit
  6. Open a Pull Request to the main branch of this repository, describing your changes and the reason for them.

✅ What We Accept

We are open to contributions involving:

  • Trajectory planning algorithms, such as Pure Pursuit.
  • Improvements to the graphical user interface to enhance usability.
  • Support for new SPIKE Prime sensors.
  • Code refactoring to improve structure and readability.
  • Documentation to help new users and developers.
  • Language corrections and translations of comments and documentation, aiming to make the project more accessible internationally. Currently, comments are in Portuguese, but they can be translated into English or other languages to improve global understanding.

⚠️ Quality Guidelines

To ensure code quality:

  • Follow the existing code style used in the project.
  • Include automated tests for new features.
  • Update documentation as necessary.
  • Avoid changes unrelated to your main contribution.

📚 Useful Resources

🤝 Code of Conduct

This project follows a Code of Conduct that promotes a respectful and inclusive environment for all contributors.

📬 Contact

For questions or suggestions, please contact the author:

Thank you for your willingness to contribute to the success of this project!