Skip to content

Latest commit

 

History

History
222 lines (148 loc) · 14 KB

CONTRIBUTING.md

File metadata and controls

222 lines (148 loc) · 14 KB
Raw

Contributing

First off, thanks for taking the time to contribute! ❤️

All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉

And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:

  • Star the project
  • Refer this project in your project's readme
  • Mention the project at local meetups with your fellow competitors
  • Mention the use of this project in judging presentations
  • Open a bug report or feature request here
  • Discuss and give feedback in our Discord

Table of Contents

🙋I Have a Question

If you want to ask a question, we assume that you have read the available Documentation.

Before you ask a question, it is best to search for existing Issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. In addition, you can also search for existing questions in the Vex Discord, the VEX Forum, or our Discord.

If you then still feel the need to ask a question and need clarification, we recommend the following:

  • Open an Issue.
  • Provide as much context as you can about what you're running into.
  • Provide Kernel, CLI, and LemLib versions (e.g PROS 3.8.0, CLI 3.4.1, LemLib 0.4.5)
  • Any additional information you think is relevant

We will then take care of the issue as soon as possible.

🧑‍💻I Want To Contribute

Legal Notice

When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.

🐛Reporting Bugs

🐛Before Submitting a Bug Report

A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.

  • Make sure that you are using the latest version of LemLib, PROS, and the CLI.
  • Determine if your bug is really a bug and not an error on your side e.g. incorrect chassis setup (Make sure that you have read the documentation. If you are looking for support, you might want to check this section).
  • To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the bug tracker.
  • Collect information about the bug:
    • Logger Messages
    • Kernel, CLI, and LemLib versions
    • Any additional templates being used and their versions
    • Can you reliably reproduce the issue?

🐛How Do I Submit a Good Bug Report?

You must never report security-related issues, vulnerabilities, or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to liamteale6@gmail.com.

We use GitHub issues to track bugs and errors. If you run into an issue with the project:

  • Open an Issue. Use the Bug Report issue template.
  • Explain the behavior you would expect and the actual behavior.
  • Provide the version of the PROS kernel, the PROS CLI, and LemLib
  • List any additional templates and their versions
  • Please provide as much context as possible and describe the reproduction steps that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
  • Provide the information you collected in the previous section.
  • Provide any additional information you think is relevant, but does not fit previous sections.

Once it's filed:

  • The project team will label the issue accordingly.
  • A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as needs-repro. Bugs with the needs-repro tag will not be addressed until they are reproduced.
  • If the team is able to reproduce the issue, it will be marked confirmed-bug, as well as possibly other tags (such as p: critical), and the issue will be left to be implemented by someone.

✨Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for LemLib, including completely new features and minor improvements to existing functionality. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.

✨Before Submitting an Enhancement

  • Make sure that you are using the latest version.
  • Read the documentation carefully and find out if the functionality is already covered, maybe by an individual configuration.
  • Perform a search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
  • Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset.

✨How Do I Submit a Good Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues. You can use the Feature Request issue template upon creation of a new issue.

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Describe the current behavior so the project team can understand the difference between your suggestion and the current behavior.
  • Explain why this enhancement would be useful to most LemLib users and/or maintainers.
  • (Optional) List possible implementations and alternatives you have in mind.

🚀Your First Code Contribution

Note

Using a development environment different from the one recommended below is fine, but you will have to adjust the steps yourself.

Note

We do not recommend using the C/C++ extension, as its slow for linting and autocomplete.

Note

At a minimum, we recommend the PROS and clangd extensions

We recommend using Visual Studio Code as your IDE. It is free, (mostly) open-source, and cross-platform. Here is a list of recommended extensions:

If asked to disable the IntelliSense in favor of clangd, do so.

In order to build the project, you need to use PROS

  • Generate compile commands: pros build-compile-commands
  • Build the project: pros build
  • Create the template zip: pros build template

You can apply the kernel to your project with the following commands

  • Fetch the kernel: pros c fetch LemLib@a.b.c-d.zip
  • Apply the kernel: pros c apply LemLib@a.b.c-d
  • Remove the template: pros c remove LemLib@a.b.c-d

In order to contribute to LemLib, you will need to fork the repository and clone it to your local machine. You can then commit your changes to your fork. Once you are done, you can create a pull request to the master branch. You can use the Pull Request Template to structure your pull request.

📝Improving The Documentation

We use a combination of Doxygen, Breathe, and Sphinx to generate our documentation. The documentation is hosted on Read The Docs, which gives us both free hosting, and automatic versioning of the documentation. It automatically deploys after every commit.

You can improve the documentation by:

Changes should be requested via a Pull Request to the LemLib repository. You can use the Pull Request Template to structure your pull request. Additionally, you should verify that the documentation builds correctly on your machine.

You can do so by installing Doxygen, and all of the python dependencies listed in docs/requirements.txt. Once you've done that, run the following commands to render the documentation:

cd docs
doxygen
make html

Then you can view the documentation by pointing your browser at the ./_build/html/index.html file.

💄Styleguides

💄C++ Coding Style

We use our own style guide for LemLib. Here are the most important rules:

  • Use lowerCamelCase for variables and functions
  • Use UpperCamelCase for classes and structs
  • Use UPPER_SNAKE_CASE for macros
  • Braces should always be on the same line as the statement
  • Pointers and references are always to the left
  • Max column width is 120 characters
  • Operators should be surrounded by spaces
  • Commas should be followed by a space
  • Indents are 4 spaces

For further information, check out .clang-format.

We use the clang-format extension to format our code. You can use the .clang-format file in the root directory of the project to configure your IDE to use the same formatting rules as we do. You can also use the clang-format command line tool to format your code. You can find more information about the tool here.

💄Commit Messages

Commit titles should be short and descriptive. They should be written in the imperative mood, i.e. as if you were commanding someone. They should not end with a period. If you are fixing an issue, you should include the issue number in the commit title. Additional information can be provided in the commit body. For example:

Add support for Differential Drivetrains (fixes #42)

This commit adds support for Differential Drivetrains. It also adds a new class called DifferentialDrivetrain, which is a subclass of Drivetrain.

Attribution

This guide is based on the contributing-gen. Make your own!