From 0102304f4a3c1638bed2f3830cc2eb56e20daaf4 Mon Sep 17 00:00:00 2001 From: Nick Garnsworthy Date: Thu, 23 Oct 2025 10:52:24 -0500 Subject: [PATCH 1/6] Add CONTRIBUTING info --- .github/CONTRIBUTING.md | 106 ++++++++++++++++++------------- .github/PULL_REQUEST_TEMPLATE.md | 5 +- 2 files changed, 67 insertions(+), 44 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 4d37ce7ec3e3..c342636a760f 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,68 +1,88 @@ -# Contributing to the FTC SDK +# Contributing to the IrishRobotics FTC2025 -The following is a set of guidelines for contributing the FIRST FTC SDK. The FTC Technology Team welcomes suggestions for improvements to core software, ideas for new features, requests for built-in support of new sensors, and well written bug reports. +The following is a set of guidelines for contributing the 2025 Irish Robotics FTC code. ## How can I contribute? -### Pull requests +If you are on the team come talk to nick. If you are not on the team your help is not needed. -__STOP!__ If you are new to git, do not understand the mechanics of forks, branches, and pulls, if what you just read is confusing, __do not__ push this button. Most likely it won't do what you think it will. +## Pull Request Process -![Pull Button](../doc/media/PullRequest.PNG) +1. Update the README.md in TeamCode with details of changes including default controls, command +purposes, and any other information deemed useful. +2. You can request any developer to approve your PR -If you are looking at this button then you've pushed some changes to your team's fork of ftctechnh/ftc_app. Congratulations! You are almost certainly finished. +## Code of Conduct -The vast majority of pull requests seen on the ftctechnh/ftc_app repository are not intended to be merged into the official SDK. Team software is just that, your team's. It's specific to the tasks you are trying to accomplish, the testing you are doing, and goals your team has. You don't want that pushed into the official SDK. +### Our Pledge -If what you've read so far makes little sense, there are some very good git learning resources online. -[Git Book](https://git-scm.com/book/en/v2) -[Interactive Git Tutorial](https://try.github.io) +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +nationality, personal appearance, race, religion, or sexual identity and +orientation. -### Guidlines for experienced GIT users. +### Our Standards -If you are absolutely certain that you want to push the big green button above, read on. Otherwise back _slowly away from keyboard_. +Examples of behavior that contributes to creating a positive environment +include: -The real intent for advanced users is often to issue a pull request from the [branch](https://www.atlassian.com/git/tutorials/using-branches/git-branch) on a local fork back to master on either the same local fork or a child of the team fork and not on the parent ftctechnh/ftc_app. See [Creating a Pull Request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/). +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members -If that is indeed the intent, then you can merge your [topic branch](https://git-scm.com/book/en/v2/Git-Branching-Branching-Workflows#Topic-Branches) into master locally by hand before pushing it up to github, or if you want a pull request for pulls between branches on the same repository because, say, you want team members to look at your software before merging into master, you can select the base fork from the dropdown on the "Open a pull request" page and select your team repo instead of ftctechnh's. +Examples of unacceptable behavior by participants include: -Alternatively, if you have a team repository forked from ftctechnh/ftc_app, and then team members individually fork from your team repository, then pull requests from the individual team member's forks will have the main team repository automatically selected as the base fork for the pull. And you won't inadvertently request to pull your team software into ftctechnh's repository. +* The use of sexualized language or imagery and unwelcome sexual attention or + advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting -The latter would be the "best" way to manage software among a large team. But as with all things git there are many options. +### Our Responsibilities -Pull requests that do not fall into the category above are evaluated by the FTC Technology Team on a case-by-case basis. Please note however that the deployment model of the SDK does not support direct pulls into ftctechnh/ftc_app. +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. -### Report bugs +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. -This section guides you through filing a bug report. The better the report the more likely it is to be root caused and fixed. Please refrain from feature requests or software enhancements when opening new issues. See Suggesting Enhancements below. +### Scope -#### Before submitting a bug report +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. -- Check the [forums](http://ftcforum.firstinspires.org/forum.php) to see if someone else has run into the problem and whether there is an official solution that doesn't require a new SDK. +### Enforcement -- Perform a search of current [issues](https://github.com/FIRST-Tech-Challenge/FtcRobotController/issues) to see if the problem has already been reported. If so, add a comment to the existing issue instead of creating a new one. +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at [INSERT EMAIL ADDRESS]. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. -#### How Do I Submit A (Good) Bug Report? +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. -Bugs are tracked as GitHub issues. Create an issue on ftctechnh/ftc_app and provide the following information. -Explain the problem and include additional details to help maintainers reproduce the problem: +### Attribution -- Use a clear and descriptive title for the issue to identify the problem. +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at [http://contributor-covenant.org/version/1/4][version] -- Describe the exact steps which reproduce the problem in as many details as possible. - -- Provide specific examples to demonstrate the steps. - -- 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 applicable, include screenshots which show you following the described steps and clearly demonstrate the problem. - -- If you're reporting that the RobotController crashed, include the logfile with a stack trace of the crash. [Example of good bug report with stack trace](https://github.com/ftctechnh/ftc_app/issues/224) - -- 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. - -### Suggesting Enhancements - -FIRST volunteers are awesome. You all have great ideas and we want to hear them. - -Enhancements should be broadly applicable to a large majority of teams, should not force teams to change their workflow, and should provide real value to the mission of FIRST as it relates to engaging youth in engineering activities. - -The best way to get momentum behind new features is to post a description of your idea in the discussions section of this repository. Build community support for it. The FTC Technology Team monitors the discussions. We'll hear you and if there's a large enough call for the feature it's very likely to get put on the list for a future release. +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 665369bbc93a..61eb6876c8af 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1 +1,4 @@ -Before issuing a pull request, please see the contributing page. +Before issuing a pull request: +- [ ] Ensure all constants are in the Constants class +- [ ] Update the backup OpMode if needed +- [ ] Update README.md \ No newline at end of file From d815ff5be2e91042fc95b94d38b808d8840ed6ce Mon Sep 17 00:00:00 2001 From: Nicholas Garnsworthy Date: Thu, 23 Oct 2025 10:57:22 -0500 Subject: [PATCH 2/6] Update contact email for reporting issues --- .github/CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index c342636a760f..11416f3b1870 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -69,7 +69,7 @@ further defined and clarified by project maintainers. ### Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team at [INSERT EMAIL ADDRESS]. All +reported by contacting the project team at ngarnsworthy@gmail.com. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. @@ -85,4 +85,4 @@ This Code of Conduct is adapted from the [Contributor Covenant][homepage], versi available at [http://contributor-covenant.org/version/1/4][version] [homepage]: http://contributor-covenant.org -[version]: http://contributor-covenant.org/version/1/4/ \ No newline at end of file +[version]: http://contributor-covenant.org/version/1/4/ From b41c340dca77ea378216358e27b965f67e9bc95c Mon Sep 17 00:00:00 2001 From: Nicholas Garnsworthy Date: Thu, 23 Oct 2025 10:58:33 -0500 Subject: [PATCH 3/6] Apply suggestion from @Copilot Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- .github/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 11416f3b1870..8bb0c2fdefce 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -4,7 +4,7 @@ The following is a set of guidelines for contributing the 2025 Irish Robotics FT ## How can I contribute? -If you are on the team come talk to nick. If you are not on the team your help is not needed. +If you are on the team come talk to Nick. If you are not on the team your help is not needed. ## Pull Request Process From 4dc52032f2350b99d1f0b1a7771afec54561c2d1 Mon Sep 17 00:00:00 2001 From: Nicholas Garnsworthy Date: Thu, 23 Oct 2025 10:59:05 -0500 Subject: [PATCH 4/6] Fix wording in enforcement section of CONTRIBUTING.md Corrected the wording in the enforcement section. --- .github/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 8bb0c2fdefce..9d6d75d2056e 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -69,7 +69,7 @@ further defined and clarified by project maintainers. ### Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team at ngarnsworthy@gmail.com. All +reported by contacting the project team. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. From 050f5c7d6e68f4856c1ce8253208e82cd3106a6d Mon Sep 17 00:00:00 2001 From: Nicholas Garnsworthy Date: Thu, 23 Oct 2025 10:59:54 -0500 Subject: [PATCH 5/6] Update .github/CONTRIBUTING.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- .github/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 9d6d75d2056e..b4a762426c9e 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing to the IrishRobotics FTC2025 -The following is a set of guidelines for contributing the 2025 Irish Robotics FTC code. +The following is a set of guidelines for contributing to the 2025 Irish Robotics FTC code. ## How can I contribute? From 69b1f52348dbc5143c9c220b79223278e93fb08b Mon Sep 17 00:00:00 2001 From: Nicholas Garnsworthy Date: Thu, 23 Oct 2025 11:00:48 -0500 Subject: [PATCH 6/6] Update .github/CONTRIBUTING.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- .github/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index b4a762426c9e..da0f704b9d6e 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -4,7 +4,7 @@ The following is a set of guidelines for contributing to the 2025 Irish Robotics ## How can I contribute? -If you are on the team come talk to Nick. If you are not on the team your help is not needed. +If you are a team member, please coordinate with Nick before making contributions. External contributions are not being accepted at this time. ## Pull Request Process