So you want to contribute changes to the project? Awesome! Here's a step-by-step guide of how to contribute:
- Fork the 'Vegetabs/MindOverMatter-CTLG' repo
- Clone your newly created fork
- Open the directory using 'Git CMD', 'VS Code' (any compatible text editor works) or GitHub Desktop
- Create a new branch using 'checkout -b' with a relevant title (INSERT_BUG-fix, etc.)
- Write changes to the relevant files
- Test your changes in a debug world with MoM-CTLG enabled
- 'add' your changes
- 'commit' your changes
- 'push' your changes to your remote fork
- Go to the 'Pull requests' tab on your repo
- Compare your branch with the relevant 'Vegetabs/MindOverMatter-CTLG' branch
- Write a description for your PR
- Publish the PR
- Wait for it to be reviewed/merged
IMPORTANT: FOR FEATURE ADDITIONS PLEASE HAVE A RELEVANT APPROVED/DISCUSSED ISSUE LINKED TO YOUR PR!
- Create an issue
- Select the 'Bug Report' template
- Title the issue '[BUG] INSERT_NAME_DESCRIBING_BUG'
- Write a short description of what the bug is
- Write how to reproduce it
- Write the expected/actual behaviour
- Provide the MoM-CTLG version you encountered it in
- Provide any screenshots (if applicable)
- Create an issue
- Select the 'Backport Request' template
- Title the issue '[BACKPORT] INSERT_PR_TITLE'
- Give a short description of the PR/why it's needed
- Link the relevant DDA PR you want backported
- Create an issue
- Select the 'Feature Request' template
- Title the issue '[FEATURE] INSERT_NAME_OF_FEATURE'
- Provide a detailed description of the feature you want implemented
- Write any alternative solutions (if applicable)
- Write how you would implement it (if you're a contributor)