Skip to content

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
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

KangarooKoala
Copy link

No description provided.


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.
Copy link
Contributor

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:

  • the number of major wpilib contributors that are active (and if this channel is considered the preferred place for ideas to being
  • The reason the discord works i.e instant messaging makes the conversations move quickly, allowing ideas to get out of the idea phase and into the planning stage quicker

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • (and if this channel is considered the preferred place for ideas to being

Could you finish this thought?

Provide more detail about Discord vs GitHub issues
Add more detail about the order of events
Helps deal with feeling like a wall of text
@KangarooKoala
Copy link
Author

Will we need a note about the Discord server being unofficial and not endorsed by FIRST? (There's a note in the Unofficial Support section of the docs on the support resources page) If so, where would we put that on the page?

@sciencewhiz
Copy link
Collaborator

Can you make the relevant updates first to allwpilib's contributing.md? That gets a lot more eyes from the development community so we can work out what exactly to say there, and then we can figure out what parts are best to leave only there and which are best to copy into frc-docs.

WRT to discord, I think it should be marked as unofficial, and because of that, it should be described as a good way to get inputs in a fast-paced manner, but not be described as a necessary step in the process. Not all WPILib developers are a part of discord, and even if they were, it's easy for stuff to get lost in discord and not seen by relevant parties, so I think the "official" discussion should remain in github. This becomes even more important as we integrate the FTC development team for 2027.

@KangarooKoala
Copy link
Author

KangarooKoala commented Jun 7, 2025

> Can you make the relevant updates first to allwpilib's contributing.md? That gets a lot more eyes from the development community so we can work out what exactly to say there, and then we can figure out what parts are best to leave only there and which are best to copy into frc-docs.

I agree that it'd get better visibility in allwpilib, but the existing wording in CONTRIBUTING.md is pretty strongly targeted towards people wanting to make changes instead of simple seeing what's going on and commenting:
https://github.com/wpilibsuite/allwpilib/blob/075cc4a20f44e2a5a61ed6139a855578cceb0b89/CONTRIBUTING.md?plain=1#L1-L3

# Contributing to WPILib

So you want to contribute your changes back to WPILib. Great! We have a few contributing rules that will help you make sure your changes will be accepted into the project. Please remember to follow the rules in the [code of conduct](https://github.com/wpilibsuite/allwpilib/blob/main/CODE_OF_CONDUCT.md), and behave with Gracious Professionalism.

RE putting everything in allwpilib first and then only bringing over some parts to frc-docs, I'd argue that frc-docs should have more general information while allwpilib should have more targeted information, since frc-docs has a much wider audience.

> WRT to discord, I think it should be marked as unofficial, and because of that, it should be described as a good way to get inputs in a fast-paced manner, but not be described as a necessary step in the process.

Yep, 100% agree that it shouldn't be necessary or be described as necessary. Did something in the text suggest that it was necessary? I thought I worded it so it wouldn't come off that way, but if it did seem to imply that, then I should reword it.

Update: Following some conversation in the unofficial Discord server, I learned that a) I gave the false impression that the info was intended to describe how to make new changes, not how to stay up to date, and b) that we'll first add a short blurb about staying up to date in README.md and a description about the overall development process (idea -> PR) in CONTRIBUTING.md, and then we'll revisit this PR.

@KangarooKoala
Copy link
Author

Most of the information in this PR has been split into wpilibsuite/allwpilib#8011 and wpilibsuite/allwpilib#8012.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants