From 7a0d51854a99ec75b2a180131a6be174cee208b1 Mon Sep 17 00:00:00 2001 From: Daniel Cronqvist Date: Sat, 26 Apr 2025 22:25:46 +0200 Subject: [PATCH] Add contribution guide --- .github/CONTRIBUTING.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 .github/CONTRIBUTING.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..bd85b70 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,14 @@ +# Welcome to the DotTiled contribution guide! + +Thanks for taking the time to contribute to DotTiled! + +## Contribution Guidelines + +- **Branching:** Always branch from the latest `dev` branch. Do not submit PRs directly to `master`. +- **Git**: Keep your commits small with intentful messages. Use `git rebase` to keep your commit history clean, never merge `dev` into your branch. If you need to update your branch with the latest changes from `dev`, use `git rebase dev`. +- **Pull Requests:** Open PRs against the `dev` branch only. Use the `.github/PULL_REQUEST_TEMPLATE/dev_template.md` PR template for your description, and ensure your PR is well-documented. +- **Testing:** All changes to DotTiled core must include relevant tests. PRs without tests will not be accepted. +- **Examples & Misc:** Updates to example projects or documentation are more flexible but should still be submitted as PRs to `dev`. +- **Code Style:** Follow existing code style and conventions. + +Thank you for helping improve DotTiled! \ No newline at end of file