Skip to content

Latest commit

 

History

History
45 lines (35 loc) · 2.52 KB

CONTRIBUTING.md

File metadata and controls

45 lines (35 loc) · 2.52 KB

Contributing to NextFTC

Thank you for considering contributing to NextFTC! We welcome all kinds of contributions, including bug reports, feature requests, documentation improvements, and code enhancements.

How to Contribute

To contribute, it's highly recommended to join the Discord server

  1. Fork the Repository: Click the "Fork" button on the top right of the repository page.
  2. Clone Your Fork: Clone your fork to your local machine using git clone https://github.com/YOUR-USERNAME/NextFTC.git, replacing YOUR-USERNAME with your GitHub username.
  3. Create a Branch: Create a new branch for your work using git checkout -b BRANCH-NAME, replacing BRANCH-NAME with the name of your feature/modification.
  4. Make Changes: Make your changes in your branch.
  5. Commit Changes: Commit your changes with a clear and descriptive commit message.
  6. Push to GitHub: Push your branch to your fork on GitHub using git push origin BRANCH-NAME, replacing BRANCH-NAME with the branch name you selected in step 3.
  7. Create a Pull Request: Open a pull request to the main branch of the original repository. Provide a clear description of your changes and link any relevant issues.

Guidelines

  • Code Style: Follow the existing code style. Double check variables are named according to the Kotlin conventions, and there are no typos in your code or documentation.
  • Tests: Your code must be well-tested and proven to accomplish its objective. There should be no apparent issues or bugs when you open a pull request.
  • Documentation: Update documentation to reflect your changes. This includes code comments and all relevant documentation files.

Reporting Bugs

  1. Search Existing Issues: Before reporting a new bug, please search existing issues to see if the bug has already been reported.
  2. Create a New Issue: If the bug hasn't been reported, create a new issue. Provide as much detail as possible, including steps to reproduce the bug, the expected result, and the actual result.

Feature Requests

  1. Search Existing Issues: Before suggesting a new feature, please search existing issues to see if the feature has already been requested.
  2. Create a New Issue: If the feature hasn't been requested, create a new issue. Provide a detailed description of the feature and its benefits.