footnotes/CONTRIBUTING.md

footnotes Contributing Guide

footnotes welcomes contributions!

Code of Conduct

Please read and ensure that you adhere to the project's Code of Conduct.

Requesting Features/Reporting Bugs

To request a new feature or to report a bug, create an Issue and choose the correct template.

Contributing Code

• footnotes uses GitHub Flow;
• branch off of main to start developing (git checkout -b <your branch>);
• ensure that your new branch has a descriptive name;
• create a remote copy of your new branch (git push);
• create a draft pull request to merge your branch with main — tag any related Issues, and if they are assigned to a Project board, this will automatically move them into the ‘In Progress’ bucket; and
• when you think you're finished, un-draft your pull request — if the PR is assigned to a Project board, this will automatically move it and any related Issues into the ‘Review in progress’ bucket.

Commits

• footnotes uses the Conventional Commits for commit message formatting;
• we recommend using Commitizen to automate this:
  • install it globally using npm install -g commitizen;
  • use git cz instead of git commit.
• keep individual commits as small as possible.

Versioning

footnotes uses WordPress Versioning.

Translating

Translations are welcome!