Source Control Practices

General

• Keep your diffs small. Unnecessarily large diffs are harder to understand.
• Everyone use the default IntelliJ formatter. This prevents the entire file being changed for a single line change, causing huge diffs.
• Don't autoformat generated files (e.g. fxml from scenebuilder). This creates a huge diff which will be overwritten next time the generator is used.
• Don't commit your IDE specific files (.idea/, *.iml etc)

Branching/Collaboration

• Use the feature branching pattern. Tutorial here.
• Push your feature branches to remote
• Make pull requests to merge your feature into master (must pass 2 code reviews and CI build first)
• Use appropriate branching names. bug/xyz for bugs, feature/abc for new features.
• Delete feature/bug branches after pull request is merged.

Issues

• Reference relevant issue in commit messages (e.g. #23 fixed null pointer exception) when a specific issue is concerned.