👍🎉 First off, thanks for taking the time to contribute! 🎉👍
The following is a set of guidelines for contributing to EasyFTC, which is hosted in the Hax Robotics Organization on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
I don't want to read this whole thing, I just have a question!!!
What should I know before I get started?
This project and everyone participating in it is governed by the EasyFTC Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].
Note: [Please don't file an issue to ask a question. You'll get faster results by using the resources below.
Join the EasyFTC Discord team:
- Join the Discord
- Even though Discord is a chat service, sometimes it takes several hours for community members to respond — please be patient!
- Use the
#generalchannel for general questions or discussion about EasyFTC - There are many other channels available, check the channel list
EasyFTC is an open source project — it is made up of multiple repositories. When you initially consider contributing to EasyFTC, you might be unsure about which repository implements the functionality you want to change or report a bug for. This section should help you with that.
EasyFTC is intentionally very modular. Nearly every element you interact with comes from a package, even fundamental things like movement and autonomous generation.
#Here's a list of the current packages:
- lcrobotics/EasyFTC - EasyFTC Core! This library automatically creates a superClass to extend across multiple OpModes as well as many other tools and organization to make programming more linear.
This section guides you through submitting a bug report for EasyFTC. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻, and find related reports 🔎.
Before creating bug reports, please check this list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible. Fill out the required template, the information it asks for helps us resolve issues faster.
Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
Bugs are tracked as GitHub issues. In order to create an issue, make one on that repository and provide the following information by filling in the template:
- Use a clear and descriptive title for the issue to identify the problem.
- Describe the exact steps which reproduce the problem in as many details as possible. When listing steps, don't just say what you did, but explain how you did it.
- Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, in which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
- Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
- Explain which behavior you expected to see instead and why.
- If you're reporting that EasyFTC crashed, include a crash report in the issue in a code block, a file attachment, or put it in a gist and provide link to that gist.
- If the problem wasn't triggered by a specific action, describe what you were doing before the problem happened and share more information using the guidelines below.
Provide more context by answering these questions:
- Did the problem start happening recently (e.g. after updating to a new version of EasyFTC) or was this always a problem?
- If the problem started happening recently, can you reproduce the problem in an older version of EasyFTC? What's the most recent version in which the problem doesn't happen? You can download older versions of EasyFTC from the releases page.
- Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.
- If the problem is related to working with files, does the problem happen for all files and projects or only some? Does the problem happen only when working with large files or files with very long lines? Is there anything else special about the files you are using?
Include details about your configuration and environment:
- Which version of EasyFTC are you using?
- What's the name and version of the OS you're using?
This section guides you through submitting an enhancement suggestion for EasyFTC, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion 📝 and find related suggestions 🔎.
Before creating enhancement suggestions, please check this list as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please include as many details as possible. Fill in the template, including the steps that you imagine you would take if the feature you're requesting existed.
- Check if there's already a package which provides that enhancement.
- Determine which repository the enhancement should be suggested in.
- Perform a cursory 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.
Enhancement suggestions are tracked as GitHub issues. After you've determined which repository your enhancement suggestion is related to, create an issue on that repository and provide the following information:
- 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.
- Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
- Describe the current behavior and explain which behavior you expected to see instead and why.
- Explain why this enhancement would be useful to most EasyFTC users and isn't something that can or should be implemented individually.
- List some other libraries or repos where this enhancement exists.
- Specify which version of EasyFTC you're using.
- Specify the name and version of the OS you're using.
Unsure where to begin contributing to EasyFTC? You can start by looking through these beginner and help-wanted issues:
- [Beginner issues][beginner] - issues which should only require a few lines of code, and a test or two.
- [Help wanted issues][help-wanted] - issues which should be a bit more involved than
beginnerissues.
Both issue lists are sorted by total number of comments. While not perfect, number of comments is a reasonable proxy for impact a given change will have.
The process described here has several goals:
- Maintain EasyFTC's quality
- Fix problems that are important to users
- Engage the community in working toward the best possible EasyFTC
- Enable a sustainable system for EasyFTC's maintainers to review contributions
Please follow these steps to have your contribution considered by the maintainers:
- Follow all instructions in the template
- Follow the styleguides
- After you submit your pull request, verify that all status checks are passing
What if the status checks are failing?
If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.
While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally after the first line
- When only changing documentation, include
[ci skip]in the commit title - Consider starting the commit message with an applicable emoji:
- 🎨
:art:when improving the format/structure of the code - 🐎
:racehorse:when improving performance - 🚱
:non-potable_water:when plugging memory leaks - 📝
:memo:when writing docs - 🐧
:penguin:when fixing something on Linux - 🍎
:apple:when fixing something on macOS - 🏁
:checkered_flag:when fixing something on Windows - 🐛
:bug:when fixing a bug - 🔥
:fire:when removing code or files - 💚
:green_heart:when fixing the CI build - ✅
:white_check_mark:when adding tests - 🔒
:lock:when dealing with security - ⬆️
:arrow_up:when upgrading dependencies - ⬇️
:arrow_down:when downgrading dependencies - 👕
:shirt:when removing linter warnings
- 🎨
All Java must adhere to Google's Java Style Guide.
All Documentation should adhere to Google's Documentation Style Guide.