Thank you for considering contributing to the CharacterSheets. We welcome any contributions that can help improve the project, including bug reports, feature requests, and code changes.
Contributions are made to this repo via Issues and Pull Requests (PRs).
To run the code locally, you will need to fork the code, and follow the instructions here.
Issues should be used to report bugs, explain UX problems, request a new feature, or to discuss potential changes before a PR is created. When you create a new Issue, a template will be loaded that will guide you through collecting and providing the information we need to investigate.
If you find an issue you want to work on, follow the Commits and Pull Request instructions!
As best as possible, try to follow Conventional Commit patterns as described here.
In general, PRs should:
- Address a single concern in the least number of changed lines as possible.
- Include documentation in the repo or on our docs site if applicable.
- Be accompanied by a complete Pull Request template (loaded automatically when a PR is created).
In general, we follow the "fork-and-pull" Git workflow
- Fork the repository to your own Github account
- Clone the project to your machine
- Create a branch locally with a succinct but descriptive name
- Commit changes to the branch (see Commits instructions)
- Push changes to your fork
- Open a PR in our repository and follow the PR template so that we can efficiently review the changes.
Join us in the RaidGuild Discord and post your question #product-support channel.