MARSProgramming / MARSProgramming/MXVI-V2
Prepare code for open source release
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
Prepare code for releasing to open source. This code needs to be released to open source ahead of the start of the 2024 season.
Items to accomplish are
- Address the items reported in the Problem pane of the IDE
- Improve documentation of the code with comments
- Refactor as necessary to maximize code reuse
- Verify changes to the code does not cause unintended behavior (run the robot through a set of scenarios at the practice field to verify it is operating correctly still)
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the items reported in the IDE's Problem pane and the existing code documentation. Then assess where comments and code reuse need improvement, and run the robot through scenarios at the practice field to check for unintended behavior. Done means the reported issues are addressed, documentation is improved, reuse is maximized, and the scenarios still pass.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- embedded-iot, robotics
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 15/100