From 63d84d8d658b98ece0974d117f5ac68abd384fe9 Mon Sep 17 00:00:00 2001 From: Aditya Hebbar Date: Tue, 4 Feb 2025 20:37:19 -0500 Subject: [PATCH 1/8] Added workflows folder --- workflows/CODE_OF_CONDUCT.md | 46 ++++++++++++++++++++++++++++++++++++ workflows/CONTRIBUTING.md | 43 +++++++++++++++++++++++++++++++++ 2 files changed, 89 insertions(+) create mode 100644 workflows/CODE_OF_CONDUCT.md create mode 100644 workflows/CONTRIBUTING.md diff --git a/workflows/CODE_OF_CONDUCT.md b/workflows/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..9da50525 --- /dev/null +++ b/workflows/CODE_OF_CONDUCT.md @@ -0,0 +1,46 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +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. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment include: + +* 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 + +Examples of unacceptable behavior by participants include: + +* 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 + +## Our Responsibilities + +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. + +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. + +## Scope + +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. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team. The project team will review and investigate all complaints, and will respond in a way that it deems 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. + +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. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, 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 diff --git a/workflows/CONTRIBUTING.md b/workflows/CONTRIBUTING.md new file mode 100644 index 00000000..ede21664 --- /dev/null +++ b/workflows/CONTRIBUTING.md @@ -0,0 +1,43 @@ +# How to contribute + +This project is a small project to program the robot for the frc tean "Redshift" who reside in Westborough, MA who will be referred to as "Redshift" throughout this document. This project is limited to current members of Redshift who are the only ones allowed to help improve it by proposing features, finding bugs, or fixing mistakes. + +To make it as easy as possible for you to contribute and for us to keep an overview, here are a few guidelines which should help us avoid all kinds of unnecessary work or disappointment. And of course, this document is subject to discussion, so please [create an issue](https://github.com/FRC4048/FRC2025_Java/issues/new?template=Blank+issue) or a pull request if you find a way to improve it! + +## Private reports + +Usually, all issues are tracked publicly on [GitHub](https://github.com/FRC4048/FRC2025_Java/issues). If you want to make a private report (e.g., for a vulnerability or to attach an example that is not meant to be published), please send an email to one of the code owners immediately. + +## Prerequisites + +Please [create an issue](https://github.com/FRC4048/FRC2025_Java/issues/new?template=Blank+issue), assuming one does not already exist, and describe your concern. Note you need a [GitHub account](https://github.com/signup/free) for this and are needed to be a current member of Redshift. + +## Describe your issue + +Clearly describe the issue: + +- If it is a bug, please describe how to **reproduce** it. If possible, attach a complete example which demonstrates the error. Please also state what you **expected** to happen instead of the error. +- If you propose a change or addition, try to give an **example** how the improved code could look like or how to use it. +- If you found a compilation error, please tell us which **compiler** (version and operating system) you used and paste the (relevant part of) the error messages to the ticket. + +For questions, feature or support requests, please [open a discussion](https://github.com/Neo-Aditya-s-personal-projects/ScoutRadioz-Data-Calculation/discussions/new). + +## Notes + + If you add or change a feature, please also try to add unit tests if you know how to or are able to. + + To run this program you'll need to: + + - Have the latest version of WPILIB installed + - Have an IDE that supports the latest version of WPILIB + - Hit the button labeled "Deploy Robot Code" if connected to a robot & "Build Robot Code" if not. + + Please do not open pull requests that address **multiple issues**. + +## Wanted + +The following areas really need contribution: + +- Improving the time complexity +- Documentation +- Making the program work upon all platforms and IDEs \ No newline at end of file From 6c0c77882e7fefafdc105109fa42257e1f0ed1d4 Mon Sep 17 00:00:00 2001 From: Aditya Hebbar Date: Tue, 4 Feb 2025 20:59:00 -0500 Subject: [PATCH 2/8] Added some of the requested changes --- workflows/CONTRIBUTING.md | 14 ++------------ 1 file changed, 2 insertions(+), 12 deletions(-) diff --git a/workflows/CONTRIBUTING.md b/workflows/CONTRIBUTING.md index ede21664..7ab159b5 100644 --- a/workflows/CONTRIBUTING.md +++ b/workflows/CONTRIBUTING.md @@ -1,6 +1,6 @@ # How to contribute -This project is a small project to program the robot for the frc tean "Redshift" who reside in Westborough, MA who will be referred to as "Redshift" throughout this document. This project is limited to current members of Redshift who are the only ones allowed to help improve it by proposing features, finding bugs, or fixing mistakes. +This project is a small project to program the robot for the frc tean "Redshift" who reside in Westborough, MA who will be referred to as "Redshift" throughout this document. This project is limited to current members of Redshift who are the only ones allowed to contribute by proposing features, finding bugs, or fixing mistakes. To make it as easy as possible for you to contribute and for us to keep an overview, here are a few guidelines which should help us avoid all kinds of unnecessary work or disappointment. And of course, this document is subject to discussion, so please [create an issue](https://github.com/FRC4048/FRC2025_Java/issues/new?template=Blank+issue) or a pull request if you find a way to improve it! @@ -20,8 +20,6 @@ Clearly describe the issue: - If you propose a change or addition, try to give an **example** how the improved code could look like or how to use it. - If you found a compilation error, please tell us which **compiler** (version and operating system) you used and paste the (relevant part of) the error messages to the ticket. -For questions, feature or support requests, please [open a discussion](https://github.com/Neo-Aditya-s-personal-projects/ScoutRadioz-Data-Calculation/discussions/new). - ## Notes If you add or change a feature, please also try to add unit tests if you know how to or are able to. @@ -32,12 +30,4 @@ For questions, feature or support requests, please [open a discussion](https://g - Have an IDE that supports the latest version of WPILIB - Hit the button labeled "Deploy Robot Code" if connected to a robot & "Build Robot Code" if not. - Please do not open pull requests that address **multiple issues**. - -## Wanted - -The following areas really need contribution: - -- Improving the time complexity -- Documentation -- Making the program work upon all platforms and IDEs \ No newline at end of file + Please do not open pull requests that address **multiple issues**. \ No newline at end of file From d34b64aaa04dceb05ace92c6ef6014693ffb7931 Mon Sep 17 00:00:00 2001 From: Aditya Hebbar Date: Wed, 5 Feb 2025 08:26:03 -0500 Subject: [PATCH 3/8] Updated CONTRIBUTING.md --- workflows/CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/workflows/CONTRIBUTING.md b/workflows/CONTRIBUTING.md index 7ab159b5..d6d1ae3d 100644 --- a/workflows/CONTRIBUTING.md +++ b/workflows/CONTRIBUTING.md @@ -18,7 +18,7 @@ Clearly describe the issue: - If it is a bug, please describe how to **reproduce** it. If possible, attach a complete example which demonstrates the error. Please also state what you **expected** to happen instead of the error. - If you propose a change or addition, try to give an **example** how the improved code could look like or how to use it. -- If you found a compilation error, please tell us which **compiler** (version and operating system) you used and paste the (relevant part of) the error messages to the ticket. +- If you found a compilation error, please paste the (relevant part of) the error messages to the ticket. ## Notes @@ -30,4 +30,4 @@ Clearly describe the issue: - Have an IDE that supports the latest version of WPILIB - Hit the button labeled "Deploy Robot Code" if connected to a robot & "Build Robot Code" if not. - Please do not open pull requests that address **multiple issues**. \ No newline at end of file + Please do not open pull requests that address **multiple issues**. From 5f76c1bbfa50e165ff076d20aca7b535a1d94f1f Mon Sep 17 00:00:00 2001 From: Aditya Hebbar Date: Wed, 5 Feb 2025 20:37:20 -0500 Subject: [PATCH 4/8] Update CONTRIBUTING.md --- workflows/CONTRIBUTING.md | 18 ------------------ 1 file changed, 18 deletions(-) diff --git a/workflows/CONTRIBUTING.md b/workflows/CONTRIBUTING.md index d6d1ae3d..3d645a11 100644 --- a/workflows/CONTRIBUTING.md +++ b/workflows/CONTRIBUTING.md @@ -4,26 +4,8 @@ This project is a small project to program the robot for the frc tean "Redshift" To make it as easy as possible for you to contribute and for us to keep an overview, here are a few guidelines which should help us avoid all kinds of unnecessary work or disappointment. And of course, this document is subject to discussion, so please [create an issue](https://github.com/FRC4048/FRC2025_Java/issues/new?template=Blank+issue) or a pull request if you find a way to improve it! -## Private reports - -Usually, all issues are tracked publicly on [GitHub](https://github.com/FRC4048/FRC2025_Java/issues). If you want to make a private report (e.g., for a vulnerability or to attach an example that is not meant to be published), please send an email to one of the code owners immediately. - -## Prerequisites - -Please [create an issue](https://github.com/FRC4048/FRC2025_Java/issues/new?template=Blank+issue), assuming one does not already exist, and describe your concern. Note you need a [GitHub account](https://github.com/signup/free) for this and are needed to be a current member of Redshift. - -## Describe your issue - -Clearly describe the issue: - -- If it is a bug, please describe how to **reproduce** it. If possible, attach a complete example which demonstrates the error. Please also state what you **expected** to happen instead of the error. -- If you propose a change or addition, try to give an **example** how the improved code could look like or how to use it. -- If you found a compilation error, please paste the (relevant part of) the error messages to the ticket. - ## Notes - If you add or change a feature, please also try to add unit tests if you know how to or are able to. - To run this program you'll need to: - Have the latest version of WPILIB installed From 0ffe35988f28423ae2da2cc2da066bd1352914c3 Mon Sep 17 00:00:00 2001 From: Aditya Hebbar Date: Wed, 5 Feb 2025 20:37:52 -0500 Subject: [PATCH 5/8] Update CONTRIBUTING.md --- workflows/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/workflows/CONTRIBUTING.md b/workflows/CONTRIBUTING.md index 3d645a11..d8d30572 100644 --- a/workflows/CONTRIBUTING.md +++ b/workflows/CONTRIBUTING.md @@ -4,7 +4,7 @@ This project is a small project to program the robot for the frc tean "Redshift" To make it as easy as possible for you to contribute and for us to keep an overview, here are a few guidelines which should help us avoid all kinds of unnecessary work or disappointment. And of course, this document is subject to discussion, so please [create an issue](https://github.com/FRC4048/FRC2025_Java/issues/new?template=Blank+issue) or a pull request if you find a way to improve it! -## Notes +## How to run To run this program you'll need to: From 7bac4381f7f2a1148be108cf434fd0eb97cbddcf Mon Sep 17 00:00:00 2001 From: Aditya Hebbar Date: Sat, 8 Feb 2025 11:36:36 -0500 Subject: [PATCH 6/8] Update CONTRIBUTING.md --- workflows/CONTRIBUTING.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/workflows/CONTRIBUTING.md b/workflows/CONTRIBUTING.md index d8d30572..ace24502 100644 --- a/workflows/CONTRIBUTING.md +++ b/workflows/CONTRIBUTING.md @@ -1,8 +1,14 @@ # How to contribute -This project is a small project to program the robot for the frc tean "Redshift" who reside in Westborough, MA who will be referred to as "Redshift" throughout this document. This project is limited to current members of Redshift who are the only ones allowed to contribute by proposing features, finding bugs, or fixing mistakes. +This project is a small project to program the robot for the FRC team "Redshift" residing in Westborough, MA, referred to as "Redshift" throughout this document. This project is limited to current members of Redshift who are the only ones allowed to contribute by proposing features, finding bugs, or fixing mistakes. -To make it as easy as possible for you to contribute and for us to keep an overview, here are a few guidelines which should help us avoid all kinds of unnecessary work or disappointment. And of course, this document is subject to discussion, so please [create an issue](https://github.com/FRC4048/FRC2025_Java/issues/new?template=Blank+issue) or a pull request if you find a way to improve it! +To make it as easy as possible for you to contribute and for us to keep an overview, here are a few guidelines that should help us avoid all kinds of unnecessary work or disappointment. And of course, this document is subject to discussion, so please [create an issue](https://github.com/FRC4048/FRC2025_Java/issues/new?template=Blank+issue) or a pull request if you find a way to improve it! + +## Prerequisites + For your branch to be accepted as a pull request, you must: + - Test it on the simulator if it includes the command. + - Test it on a robot owned by Redshift if you can. + - Test it on the robot created for the competition "Reefscape" if the robot is completely built. ## How to run From 64549fe7506b4da45ed57045db0e26ae6cca25b2 Mon Sep 17 00:00:00 2001 From: Aditya Hebbar Date: Sat, 8 Feb 2025 15:16:24 -0500 Subject: [PATCH 7/8] Update CONTRIBUTING.md --- workflows/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/workflows/CONTRIBUTING.md b/workflows/CONTRIBUTING.md index ace24502..68b91d81 100644 --- a/workflows/CONTRIBUTING.md +++ b/workflows/CONTRIBUTING.md @@ -2,7 +2,7 @@ This project is a small project to program the robot for the FRC team "Redshift" residing in Westborough, MA, referred to as "Redshift" throughout this document. This project is limited to current members of Redshift who are the only ones allowed to contribute by proposing features, finding bugs, or fixing mistakes. -To make it as easy as possible for you to contribute and for us to keep an overview, here are a few guidelines that should help us avoid all kinds of unnecessary work or disappointment. And of course, this document is subject to discussion, so please [create an issue](https://github.com/FRC4048/FRC2025_Java/issues/new?template=Blank+issue) or a pull request if you find a way to improve it! +To make it as easy as possible for you to contribute and for us to keep an overview, here are a few guidelines that should help us avoid unnecessary work or disappointment. Of course, this document is subject to discussion, so please [create an issue](https://github.com/FRC4048/FRC2025_Java/issues/new?template=Blank+issue) or a pull request if you find a way to improve it! ## Prerequisites For your branch to be accepted as a pull request, you must: From 310884dadd0ad4e7140cbe70b9b02a04681e9d76 Mon Sep 17 00:00:00 2001 From: Aditya Hebbar Date: Sat, 8 Feb 2025 16:33:44 -0500 Subject: [PATCH 8/8] Update CONTRIBUTING.md --- workflows/CONTRIBUTING.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/workflows/CONTRIBUTING.md b/workflows/CONTRIBUTING.md index 68b91d81..cd8d29e0 100644 --- a/workflows/CONTRIBUTING.md +++ b/workflows/CONTRIBUTING.md @@ -1,8 +1,6 @@ # How to contribute -This project is a small project to program the robot for the FRC team "Redshift" residing in Westborough, MA, referred to as "Redshift" throughout this document. This project is limited to current members of Redshift who are the only ones allowed to contribute by proposing features, finding bugs, or fixing mistakes. - -To make it as easy as possible for you to contribute and for us to keep an overview, here are a few guidelines that should help us avoid unnecessary work or disappointment. Of course, this document is subject to discussion, so please [create an issue](https://github.com/FRC4048/FRC2025_Java/issues/new?template=Blank+issue) or a pull request if you find a way to improve it! +This is a small project to program the Redshift robot team in Westborough, MA. Only current members can propose features, report bugs, or fix mistakes. Here are guidelines to streamline contributions and avoid unnecessary work or disappointment. ## Prerequisites For your branch to be accepted as a pull request, you must: