-
Notifications
You must be signed in to change notification settings - Fork 282
Add information about watching changes #3049
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
KangarooKoala
wants to merge
6
commits into
wpilibsuite:main
Choose a base branch
from
KangarooKoala:watching-changes
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
5814831
Add information about watching changes
KangarooKoala b5002fc
Update wording
KangarooKoala 52a6c4e
Fix list
KangarooKoala ed108c0
Bold the different stages
KangarooKoala 3d06d29
Adjust organization
KangarooKoala a92598b
Adjust wording to be more like options
KangarooKoala File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
# Watching changes | ||
|
||
This document describes different ways to stay up-to-date on the changes being made to the WPILib suite. | ||
|
||
## Stages of development | ||
|
||
To provide context about the different ways to stay up to date, below are the relevant stages of development: | ||
|
||
- Discord: The [Unofficial FIRST Robotics Competition Discord Server](https://discord.com/invite/frc) contains a programming discussion channel where people bring up their initial ideas and then receive feedback on them, either fleshing them out or learning why they might not be good ideas. Most of the major changes will have some discussion in here, but not all. | ||
- GitHub issue: Issues on the relevant GitHub repository are the next step toward a change being implemented. If the idea has gone through Discord, then this simply presents the fleshed out idea; Otherwise, this presents the idea and sometimes get initial discussion. Sometimes changes will skip this step and move straight to a pull request. | ||
KangarooKoala marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- GitHub design document: Very major changes will first create a design doc in a pull request to the relevant GitHub repository. Compared to a GitHub issue, a design doc provides a more specific and detailed description of both the changes and the throught process. Only very major features or changes will create a design doc, and sometimes a design doc is included in the pull request implementing the changes. | ||
- GitHub pull request: A pull request implements the changes and gets reviewed by members of the WPILib team. Every change is implemented through a pull request. | ||
- GitHub commits: After a pull request is reviewed and merged, it shows up in the list of commits to that repository. Every change will show up in the commit list of the relevant branch. | ||
- Release notes: New releases are accompanied by release notes, which summarize all of the changes made since the previous release with links to the pull requests implementing them. There is also :doc:`a yearly changelog </docs/yearly-overview/yearly-changelog>` summarizing the changes made between years. | ||
- Beta testing: Between competition seasons are beta periods where teams can test the new changes, providing feedback about bugs or ways to improve the team experience. | ||
|
||
## Discussing proposed changes | ||
|
||
To provide feedback as soon as possible about proposed changes, you will need to be active where the initial discussion happens. This initial discussion usually happens in the Unofficial FIRST Robotics Competition Discord Server, but sometimes it happens in GitHub issues or directly in GitHub pull requests. | ||
|
||
## Viewing in-progress changes | ||
|
||
Every change must be implemented through a GitHub pull request, so watching the pull requests will ensure you see all changes being made. | ||
|
||
There are two useful tools for watching pull requests or issues: | ||
- The GitHub issues and pull requests pages provide a ``updated:>=YYYY-MM-DD`` filter that shows changes made since a particular date. If you record the last day you checked, you can ensure you catch up on all issues or pull requests. | ||
- The GitHub repository page provides a [watch feature](https://docs.github.com/en/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#configuring-your-watch-settings-for-an-individual-repository) that allows you to subscribe to notifications on that repository. To select just issues and/or pull requests, select the "Custom" option. | ||
|
||
## Seeing implemented changes | ||
|
||
To stay up to date on what changes have been made, you have two options based on how often you want to check. To see new changes as soon as possible, check the commit history of the active branches. Commits tend to be made in batches, so most days there are no new commits, making this very low effort. For an even lower effort method, you can check the release notes or yearly changelog. | ||
|
||
## Testing changes | ||
|
||
To test the new changes for the upcoming season, test out the beta versions. It is also possible to test out the changes before the beta period starts, but it takes more work. See [Using Development Builds](https://github.com/wpilibsuite/allwpilib/blob/main/DevelopmentBuilds.md) on the allwpilib repository for details. | ||
|
||
## Quick links | ||
|
||
Below are some useful links for staying up to date: | ||
|
||
- [WPILib issues page](https://github.com/wpilibsuite/allwpilib/issues) | ||
- [WPILib pull requests page](https://github.com/wpilibsuite/allwpilib/pulls) | ||
- [WPILib commits to main](https://github.com/wpilibsuite/allwpilib/commits/main/) | ||
- [WPILib releases page](https://github.com/wpilibsuite/allwpilib/tags) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it's important to mention:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you finish this thought?