Thank you for contributing to frc-docs and the WPILib project 😄
The first thing is to familiarize yourself with the Contribution Guidelines. These set of articles guide you through getting a build environment setup and familiar with the style used in the frc-docs project. Additionally, documentation is written with reStructuredText, an advanced markup ✏️ language.
Once you're familiar with how the project is structure, take a look at the Github Issues. These issues are marked with various labels to easier organize things. Here is a cheat sheat:
Addition - Minor addition to an existing articleHelp Wanted - Used to describe issues that require a bit more knowledge of the project/WPILib and need extra attentionGood First Issue - Is used to mark issues that can be solved with relatively simple additions, such as a small content blurb or change.Contributors Welcome - Mostly all issues are open to contributors. Issues completely open for consideration and not following under other categories are labelled with this. Some issues require additional discussion, so we'd like you to hold off 🛑 until we can work out the implementationComponent: X - This PR or issue affects a certain component of the WPILib software suiteNeeds Design Decision - This is used for controversial content, or content that needs conversation on the correct implementation or solution. You are welcome to comment on the issue with your thoughts.Waiting on: WPILib - We're waiting on something to get implemented or released in WPILibWaiting on: Dependency - Waiting on some sort of external dependency before we can move forwardWaiting on: FIRST - Waiting for an official decision for FIRST. This is used for content that requires HQ approval before merge.High Priority - This is used to signify issues of the utmost importance. These issues should get solved ASAP.i18n - This is used to mark something that is related to translating or translation.Type: Structure - This is used to mark something related to configuration or structure of the repository.Type: Cleanup - General cleanup of the repo or contentType: Style/CSS - Changes made to the style of the website. This will usually coincide with a Waiting on: FIRST label.Type: Configuration - Changes made to the configuration of the project; CI, Build, Extensions, etc.Examples - Highlights a change to an example somewhereComponent: XY - What category of content is being changed
Additionally, as mentioned in the contribution guidelines, hardware PRs can often require approval from FIRST. Please be patient as this can require an extended period of time before merge.
Sometimes a PR can get loss in the abyss 🏃 (forgotten about) and needs review from a repository maintainer. If that's the case, feel free to ping @wpilibsuite/documentation for further review. Be gentle with the pings, as many of us have full-time jobs alongside our volunteer work with WPILib.
Lastly, PRs need to be kept up-to-date. This includes merging/rebasing master back into your branch, and addressing any review comments given. PRs can be closed if stale, to signify that the issue is still open for contributors.
Thank you for contributing to frc-docs and the WPILib project 😄
The first thing is to familiarize yourself with the Contribution Guidelines. These set of articles guide you through getting a build environment setup and familiar with the style used in the frc-docs project. Additionally, documentation is written with reStructuredText, an advanced markup ✏️ language.
Once you're familiar with how the project is structure, take a look at the Github Issues. These issues are marked with various labels to easier organize things. Here is a cheat sheat:
Addition- Minor addition to an existing articleHelp Wanted- Used to describe issues that require a bit more knowledge of the project/WPILib and need extra attentionGood First Issue- Is used to mark issues that can be solved with relatively simple additions, such as a small content blurb or change.Contributors Welcome- Mostly all issues are open to contributors. Issues completely open for consideration and not following under other categories are labelled with this. Some issues require additional discussion, so we'd like you to hold off 🛑 until we can work out the implementationComponent: X- This PR or issue affects a certain component of the WPILib software suiteNeeds Design Decision- This is used for controversial content, or content that needs conversation on the correct implementation or solution. You are welcome to comment on the issue with your thoughts.Waiting on: WPILib- We're waiting on something to get implemented or released in WPILibWaiting on: Dependency- Waiting on some sort of external dependency before we can move forwardWaiting on: FIRST- Waiting for an official decision for FIRST. This is used for content that requires HQ approval before merge.High Priority- This is used to signify issues of the utmost importance. These issues should get solved ASAP.i18n- This is used to mark something that is related to translating or translation.Type: Structure- This is used to mark something related to configuration or structure of the repository.Type: Cleanup- General cleanup of the repo or contentType: Style/CSS- Changes made to the style of the website. This will usually coincide with aWaiting on: FIRSTlabel.Type: Configuration- Changes made to the configuration of the project; CI, Build, Extensions, etc.Examples- Highlights a change to an example somewhereComponent: XY- What category of content is being changedAdditionally, as mentioned in the contribution guidelines, hardware PRs can often require approval from FIRST. Please be patient as this can require an extended period of time before merge.
Sometimes a PR can get loss in the abyss 🏃 (forgotten about) and needs review from a repository maintainer. If that's the case, feel free to ping @wpilibsuite/documentation for further review. Be gentle with the pings, as many of us have full-time jobs alongside our volunteer work with WPILib.
Lastly, PRs need to be kept up-to-date. This includes merging/rebasing master back into your branch, and addressing any review comments given. PRs can be closed if stale, to signify that the issue is still open for contributors.