Contribution guide
Documentation improvements are always welcome. Contributions must benefit PawFinder users. Create an issue and/or make a pull request.
Pull request tips
- Fork this repository to a personal GitHub account.
- Build a local copy of the documentation from the fork.
- Install Vale in the development environment.
- If using VS Code, install extensions markdownlint and Vale VS Code.
- Test all changes locally before submitting a pull request.
- Pull requests must not require more content to function.
- Ideally, pull requests should address an existing issue, but this isn’t required.
- Don’t submit pull requests with lint or Vale errors in the content or code examples.
Troubleshooting
Documentation build fails locally
Revisit the Installation Guide.
Make sure all software requirements installed correctly.
For example, ensure Node.js
and npm
are up to date. Run npm install in the fork directory,
then attempt the build again. If directly calling
json-server,
ensure the version is at least 0.17.4.
Vale or markdownlint extensions don’t appear in VS Code
Install the extensions from
the Visual Studio Code marketplace.
Reload VS Code (Ctrl+R on Windows/Linux, Cmd+R on Mac) after installation.
Vale reports errors but the content appears correct
Check the .vale.ini configuration file in the repository root.
Use vale . to run Vale from the command line and observe
detailed error output.
Pull request marked as having lint errors
Run npm run lint locally to identify errors before submission.
Most formatting issues can be auto-fixed with npm run lint:fix.
Changes don’t appear after pushing to GitHub
GitHub Pages can take a few minutes to rebuild and deploy.
Wait a few minutes, then refresh the site. Clear the browser cache
(Ctrl+Shift+Delete on Windows/Linux, Cmd+Shift+Delete on Mac)
if changes still don’t appear.