Add Contributing Guidelines and Code of Conduct (#184)

* Add CoC

* Add Contributing Guidelines

* Clean up README, link new files
This commit is contained in:
Mysteryusy 2025-06-27 18:23:50 +02:00 committed by GitHub
parent c44a7d5403
commit c245a78372
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 145 additions and 32 deletions

View file

@ -1,37 +1,8 @@
# Daggerheart # Daggerheart
#### For Foundry VTT This is a repo for a Foundry VTT implementation of daggerheart. It is not associated with Critical Role or Darrington Press.
This is a repo for a Foundry VTT implementation of daggerheart. It is not associated with critical role ## Setup
or darrington press.
# Table Of Contents
- [Overview](#overview)
- [Developer Guide](#developer-guide)
# Overview
# Developer Guide
#### Coding Practises
##### Style Code
The project is set up for Prettify. Make sure you've run `npm install` since it was added.
There is a pre-commit hook that will automatically run prettify on the files you've changed whenever you do a commit to maintain the formating.
##### Branches And Pull Requests
During pre-release development, we are making use of `main` as the development branch. Once release is getting closer we will instead be making a `dev` branch to base development from to make `main` more stable.
When you work on an issue or feature, start from `main` and make a new branch. Branches should be topically named and with the associated Issue number if it relates to an Issue. EX: `#6/Level-Up-Bugginess`.
---
Once you're finished with an issue or feature, open a Pull Request on Github for that branch.
The Reviewers Team will be approving submissions. This is mainly since we have a wide spread of experience with system building and the system itself, and we do want the system to become something great. As time goes on, more collaborators are likely to be added as reviewers.
#### Setup
- Open a terminal in the directory with the repo `cd <path>/<to>/<repo>` - Open a terminal in the directory with the repo `cd <path>/<to>/<repo>`
- NOTE: The repo should be placed in the system files are or somewhere else and a link (if on linux) is placed in the system directory - NOTE: The repo should be placed in the system files are or somewhere else and a link (if on linux) is placed in the system directory
@ -52,4 +23,8 @@ The Reviewers Team will be approving submissions. This is mainly since we have a
Now you should be able to build the app using `npm start` Now you should be able to build the app using `npm start`
[Foundry VTT Website][1] [Foundry VTT Website][1]
[1]: https://foundryvtt.com/ [1]: https://foundryvtt.com/
## Contributing
Looking to contribute to the project? Look no further, check out our [contributing guide](contributing.md), and keep the [Code of Conduct](coc.md) in mind when working on things.

66
coc.md Normal file
View file

@ -0,0 +1,66 @@
# Code of Conduct
## 💚 Our Commitment
As contributors and maintainers of **Foundryborne**, we are dedicated to fostering a safe, inclusive, and welcoming environment for everyone — regardless of background, identity, or experience level.
We want this project to be a space where *everyone* feels comfortable sharing ideas, collaborating, and learning together.
---
## 🤝 Our Standards
We expect all participants in our community (including issues, pull requests, discussions, and other communications) to:
- Be respectful and considerate
- Use inclusive and welcoming language
- Assume good intentions and clarify misunderstandings
- Offer constructive feedback
- Accept feedback graciously
- Avoid demeaning, discriminatory, or harassing behavior or speech
Unacceptable behaviors include:
- Personal attacks
- Trolling, baiting, or inflammatory comments
- Harassment in any form (public or private)
- Publishing private information (doxing) without consent
- Disruptive behavior that derails conversations or community efforts
---
## 📣 Reporting Issues
If you experience or witness unacceptable behavior, please report it by contacting a maintainer privately. You can also open a confidential issue or reach out through our community platform (e.g., Discord or email — TBD).
We take all reports seriously and will treat them with the confidentiality and respect they deserve.
---
## 🛠 Enforcement
Project maintainers are responsible for clarifying standards of acceptable behavior and may take appropriate and fair corrective action in response to any instance of unacceptable behavior.
This may include warnings, temporary or permanent bans, or removing content that violates the Code of Conduct.
---
## 🌍 Scope
This Code of Conduct applies to:
- All project spaces, including GitHub repositories, discussions, issues, and pull requests
- Any official community channels associated with the project (e.g., Discord, forums, etc.)
- Both public and private interactions when representing the project
---
## 🙏 Attribution
This Code of Conduct is based on the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1.
For questions or feedback, feel free to open a discussion or contact the maintainers.
---
> Let's keep **Foundryborne** a friendly and collaborative space for TTRPG lovers, devs, and curious frogs alike. 🐸

72
contributing.md Normal file
View file

@ -0,0 +1,72 @@
# Contributing to Foundryborne
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.
---
## 🤝 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 — were all here to build something great together.
---
## 🧭 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**!
🐸🛠️