Skip to content

Commit 9b33f8f

Browse files
authored
Add CONTRIBUTING info (#20)
Before issuing a pull request, please see the contributing page.
2 parents b7b89a2 + 69b1f52 commit 9b33f8f

File tree

2 files changed

+67
-44
lines changed

2 files changed

+67
-44
lines changed

.github/CONTRIBUTING.md

Lines changed: 63 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,68 +1,88 @@
1-
# Contributing to the FTC SDK
1+
# Contributing to the IrishRobotics FTC2025
22

3-
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.
3+
The following is a set of guidelines for contributing to the 2025 Irish Robotics FTC code.
44

55
## How can I contribute?
66

7-
### Pull requests
7+
If you are a team member, please coordinate with Nick before making contributions. External contributions are not being accepted at this time.
88

9-
__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.
9+
## Pull Request Process
1010

11-
![Pull Button](../doc/media/PullRequest.PNG)
11+
1. Update the README.md in TeamCode with details of changes including default controls, command
12+
purposes, and any other information deemed useful.
13+
2. You can request any developer to approve your PR
1214

13-
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.
15+
## Code of Conduct
1416

15-
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.
17+
### Our Pledge
1618

17-
If what you've read so far makes little sense, there are some very good git learning resources online.
18-
[Git Book](https://git-scm.com/book/en/v2)
19-
[Interactive Git Tutorial](https://try.github.io)
19+
In the interest of fostering an open and welcoming environment, we as
20+
contributors and maintainers pledge to making participation in our project and
21+
our community a harassment-free experience for everyone, regardless of age, body
22+
size, disability, ethnicity, gender identity and expression, level of experience,
23+
nationality, personal appearance, race, religion, or sexual identity and
24+
orientation.
2025

21-
### Guidlines for experienced GIT users.
26+
### Our Standards
2227

23-
If you are absolutely certain that you want to push the big green button above, read on. Otherwise back _slowly away from keyboard_.
28+
Examples of behavior that contributes to creating a positive environment
29+
include:
2430

25-
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/).
31+
* Using welcoming and inclusive language
32+
* Being respectful of differing viewpoints and experiences
33+
* Gracefully accepting constructive criticism
34+
* Focusing on what is best for the community
35+
* Showing empathy towards other community members
2636

27-
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.
37+
Examples of unacceptable behavior by participants include:
2838

29-
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.
39+
* The use of sexualized language or imagery and unwelcome sexual attention or
40+
advances
41+
* Trolling, insulting/derogatory comments, and personal or political attacks
42+
* Public or private harassment
43+
* Publishing others' private information, such as a physical or electronic
44+
address, without explicit permission
45+
* Other conduct which could reasonably be considered inappropriate in a
46+
professional setting
3047

31-
The latter would be the "best" way to manage software among a large team. But as with all things git there are many options.
48+
### Our Responsibilities
3249

33-
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.
50+
Project maintainers are responsible for clarifying the standards of acceptable
51+
behavior and are expected to take appropriate and fair corrective action in
52+
response to any instances of unacceptable behavior.
3453

35-
### Report bugs
54+
Project maintainers have the right and responsibility to remove, edit, or
55+
reject comments, commits, code, wiki edits, issues, and other contributions
56+
that are not aligned to this Code of Conduct, or to ban temporarily or
57+
permanently any contributor for other behaviors that they deem inappropriate,
58+
threatening, offensive, or harmful.
3659

37-
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.
60+
### Scope
3861

39-
#### Before submitting a bug report
62+
This Code of Conduct applies both within project spaces and in public spaces
63+
when an individual is representing the project or its community. Examples of
64+
representing a project or community include using an official project e-mail
65+
address, posting via an official social media account, or acting as an appointed
66+
representative at an online or offline event. Representation of a project may be
67+
further defined and clarified by project maintainers.
4068

41-
- 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.
69+
### Enforcement
4270

43-
- 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.
71+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
72+
reported by contacting the project team. All
73+
complaints will be reviewed and investigated and will result in a response that
74+
is deemed necessary and appropriate to the circumstances. The project team is
75+
obligated to maintain confidentiality with regard to the reporter of an incident.
76+
Further details of specific enforcement policies may be posted separately.
4477

45-
#### How Do I Submit A (Good) Bug Report?
78+
Project maintainers who do not follow or enforce the Code of Conduct in good
79+
faith may face temporary or permanent repercussions as determined by other
80+
members of the project's leadership.
4681

47-
Bugs are tracked as GitHub issues. Create an issue on ftctechnh/ftc_app and provide the following information.
48-
Explain the problem and include additional details to help maintainers reproduce the problem:
82+
### Attribution
4983

50-
- Use a clear and descriptive title for the issue to identify the problem.
84+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
85+
available at [http://contributor-covenant.org/version/1/4][version]
5186

52-
- Describe the exact steps which reproduce the problem in as many details as possible.
53-
54-
- Provide specific examples to demonstrate the steps.
55-
56-
- 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.
57-
58-
- 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)
59-
60-
- 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.
61-
62-
### Suggesting Enhancements
63-
64-
FIRST volunteers are awesome. You all have great ideas and we want to hear them.
65-
66-
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.
67-
68-
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.
87+
[homepage]: http://contributor-covenant.org
88+
[version]: http://contributor-covenant.org/version/1/4/

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1-
Before issuing a pull request, please see the contributing page.
1+
Before issuing a pull request:
2+
- [ ] Ensure all constants are in the Constants class
3+
- [ ] Update the backup OpMode if needed
4+
- [ ] Update README.md

0 commit comments

Comments
 (0)