Code in the Orca repo is expected to follow a certain set of style guidelines. Each directory contains a .editorconfig file to be integrated with developer IDEs, and generally serves as a list of details for how code should be formatted.
Commit messages should follow the Semantic Commit Messages gist. Similarly, branch names should follow a similar format such as feature/, refactor/, etc.
Pull requests submitted to Orca are expected to be small, covering only a single feature (fix, refactor, etc.) to be added to the repository. Issues that apply to the changes should be linked. If a pull request is in progress, it should be marked as a draft.
Titles should be a brief description of what the changes aim to do, and the larger explanation of the pull request should take the following format:
- Description: A longer explanation of what issues are being addressed and/or what feature is being added.
- Solution: An overview of what was changed. Often, a bullet-point list of high-level changes will suffice.