Welcome and thank you for considering contributing to the Learn RPGs project!
Reading and following these guidelines will help us make contributing to this project as easy as possible.
Contributions are made to this repo via Issues and Pull Requests (PRs). Please search for existing Issues and PRs before creating your own.
The website is built using Jekyll and only requires basic knowledge of Markdown to start contributing. Look at the RPG page template to see what information is needed for an RPG page.
Issues should be used to report problems with an existing page, request a new RPG page be included, or to discuss potential changes before a PR is created.
If you find an Issue that addresses the issue you want to raise, please add your own thoughts to the existing issue rather than creating a new one. Adding a reaction can also help by indicating to our maintainers that a particular issue is affecting more than just the reporter.
PRs to our website are always welcome and are the quickest way to get things added to the site. In general, PRs should:
- Add a single RPG to the site.
- Fix typos/grammar in one RPG page.
- Handle style/layout issues.
For changes that significantly modify the website style, it's best to open an Issue to discuss your proposal first. This is not required but can save time creating and reviewing changes.
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
- Following any formatting and testing guidelines specific to this repo
- Push changes to your fork
- Open a PR in our repository and follow the PR template so that we can efficiently review the changes.