mirror of
https://github.com/Foundryborne/daggerheart.git
synced 2026-04-21 15:03:37 +02:00
updated contributing guidelines (#1800)
This commit is contained in:
parent
8d8dea81fe
commit
a62d28cd96
1 changed files with 5 additions and 74 deletions
|
|
@ -1,78 +1,9 @@
|
||||||
# Contributing to Foundryborne
|
# Contributing to Daggerheart
|
||||||
|
|
||||||
Welcome! This is a community-driven project to bring [Daggerheart](https://www.daggerheart.com/) to [FoundryVTT](https://foundryvtt.com/) as a full system. We're excited to have you here and appreciate your interest in contributing.
|
Thank you for your interest in contributing to the Foundryborne project!
|
||||||
|
|
||||||
---
|
To ensure that all contributions align with our project goals and architectural standards, we ask that you **do not submit outside contributions without first receiving feedback from the development team.**
|
||||||
|
|
||||||
## 🤝 How to Contribute
|
If you have an idea or a fix you'd like to contribute, please start a discussion or open an issue first. We'd love to hear from you and collaborate on the best way to move forward!
|
||||||
|
|
||||||
We welcome contributions of all kinds:
|
Thank you for your understanding and support.
|
||||||
|
|
||||||
- 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](https://github.com/Foundryborne/daggerheart/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**!
|
|
||||||
|
|
||||||
🐸🛠️
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue