We welcome all contributions to documenting PGM and making it approachable for everyone, regardless of their expertise. This document serves as a guideline to establish a standard when it comes to submitting changes.
PGM Documentation provides detailed and accurate information about features offered by PGM that mapmakers and server administrators can take advantage of.
- Git (advanced users), GitHub Desktop (recommended), or alternative GUI clients.
- NodeJS (LTS version preferred)
- Text editors like Notepad++, Visual Studio Code, or Sublime Text
- If you are on Windows, avoid using the built-in Notepad program as it lacks several features and can affect files in unexpected ways.
- Additionally, Windows users should enable file extensions by clicking
View,Show, and selectingFile name extensions.
- Clone this repository.
git clone git@github.com:PGMDev/Website.git - Navigate to the repository in the terminal, and then run
npm install.- You will only need to do this occasionally, especially for package updates.
- After installation finishes, run
npm startto start a local webserver.- You can stop this at any time by pressing
Ctrl+C.
- You can stop this at any time by pressing
- Make your changes, which will appear in your web browser.
- Commit your changes, using the
-Sand-stag to sign and certify the origin of your contributions.git commit -S -s -m "A short description of your changes" - Submit changes in a pull request for review and feedback.
- Depending on where you host it, you can build the website using
npm run buildif you intend to upload it yourself or build it and deploy it to GitHub Pages using the Action workflow.- Some modifications will be needed to deploy outside the pgm.dev environment.
Before opening a pull request, please:
- Verify that there is no ongoing discussion concerning the implementation you wish to contribute. You can search for such a discussion in the plugin's repository issues page.
- Make sure your contribution follows American (US) English grammar rules and spelling, e.g. "color" and not "colour" or "center" and not "centre."
- If editing pages in the
mdxformat, try to use Markdown and avoid HTML as much as possible. - PGMDev enforces the Developer Certificiate of Origin (DCO). As such, you must sign off your commits.