jussi/DotTiled
1
0
Fork 0
mirror of https://github.com/dcronqvist/DotTiled.git synced 2025-05-08 15:16:04 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #88 from dcronqvist/contribution-guide

Browse source 
Add contribution guide
This commit is contained in:
dcronqvist 2025-04-26 22:31:00 +02:00 • committed by GitHub
commit a3544c3b38
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 14 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

14
.github/CONTRIBUTING.md vendored Normal file
View file

@ -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!