Prepare code for open source release

Open
#1 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
15/100
Issue type
Refactor
Clarity
Needs clarification
Activity status
Stale
Tech stack
java
Domain
embedded-iot, robotics

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.

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)
Dominant language
Java
Stars
0
Forks
0
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from MARSProgramming/MXVI-V2

All issues in MARSProgramming/MXVI-V2

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.