Neptune

Yonder Deep 2026

To Get Started:

READ DOCS/StartHere.md

Branch and Commit Management

A general guideline is to follow the conventional commit standard and the conventional branch standard.

Main Branch

• main is the primary working branch and should always contain stable, tested code.
• All code in main must pass automated tests, simulation, and peer review.
• Do not force push to main, create your own branch before working on your issue.

Merge Process

1. Create a pull request from your branch to main
2. Ensure all tests pass (and write your own as needed)
3. Test in simulation if possible
4. Request review from at least one team member
5. Address review comments
6. Merge only after approval

Inline Comments

• Use inline comments for complex logic or non-obvious decisions
• Explain the "why," not the "what"
• Keep comments up-to-date with code changes
• Please do not fill files with obvious comments

AI Coding Policy

There is no enforced rule about which agents can or cannot be used. You are welcome to use AI according to your own judgement. However:

1. You are always responsible for all of the code within pull requests you open, regardless of if you or an agent produced it.
2. You are expected to check AI code yourself, to follow good coding practices, and to match the style of the codebase before you ask for review.
3. Write pull requests descriptions yourself. It is better to produce a short description of what you understand rather than generate one you do not. If you do not know enough about the code you are pushing to write a description for a pr, you are likely violating point 2.

Contact

If you have any questions or concerns about this project, please contact us:

• Team members should use the discord channels
• Non team members: Open a Github issue.