2.5 KiB
Contributing to Foundryborne
Welcome! This is a community-driven project to bring Daggerheart to FoundryVTT as a full system. We're excited to have you here and appreciate your interest in contributing.
🤝 How to Contribute
We welcome contributions of all kinds:
- Bug reports
- Feature suggestions
- Code contributions
- UI/UX mockups
- Documentation improvements
- Questions and discussions
Please be respectful and collaborative — we’re all here to build something great together.
Community Translations
Please note that we are not accepting community translations in the main project. Instead, community translations should be published as a module.
🧭 General Guidelines
- Use GitHub Issues to report bugs or propose features
- Start a Discussion for larger ideas or questions
- Open a Pull Request once you've confirmed your work aligns with project direction
- Keep things modular and maintainable — if you're not sure how to structure something, ask!
- Orient your code on existing examples, and feel free to suggest a standard if it makes things clearer
🗂️ Project Structure
Please try to follow the general logic of the existing code when submitting PRs.
We encourage contributors to leave comments or open Discussions when proposing structural or organizational changes.
🧾 Issue & PR Best Practices
For Issues:
- Use clear, descriptive titles
- Provide a concise explanation of the problem or idea
- Include reproduction steps or example scenarios if it's a bug
- Add screenshots or logs if helpful
For Pull Requests:
- Use a clear title summarizing the change
- Provide a brief description of what your code does and why
- Link to any related Issues
- Keep PRs focused — smaller is better
🔖 Labels and Boards
We use GitHub labels to help organize contributions. If your issue or PR relates to a specific category, feel free to tag it. There is also a GitHub Project Board to help track active work and priorities.
📣 Communication
Discussions are currently happening on GitHub — in Issues, PRs, and GitHub Discussions. You're welcome to use any of these, though we may consolidate to one in the future.
🤗 Thank You!
Whether you're fixing a typo or designing entire mechanics — every contribution matters. Thank you for helping bring Daggerheart to life in FoundryVTT through Foundryborne!
🐸🛠️