Rumperuu/footnotes
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
This repository has been archived on 2023-08-16. You can view files and clone it, but cannot push or open issues or pull requests.
footnotes/CONTRIBUTING.md
Ben Goldsworthy 6a1117be15
ci: improve release process, clean up and re-org repo, add automated minification (#143) 
* ci: update scripts

* release 2.7.1

* remove tracked stylesheets

* docs: revert stable tag to 2.7.0

* chore: move Plugin source into own dir

* docs: delete info texts

These can now be found in the [project wiki][wiki].

[wiki]: https://github.com/markcheret/footnotes/wiki

* docs: tweak contributing guide

* ci: reflect new directory structure

* chore: update gitignore

* chore: reflect new dir structure

* docs: update documentation

* build(linting): add Husky hooks, Markdown linting, lint all MD files

* fix pre-push command

* fix pre-push command

* build: add stylesheet, JS minification

* ci: add linting steps

* ci: comment out CSS linting step (that's going to be a whole *thing*)

* ci: minify all JS files

* ci: call correct JS file

* chore: lint

* ci: fix PHP linting commands

* chore: increment version constant string

* ci: concat AMP stylesheets

* ci: improve build scripts

* chore: add assets dir
2021-04-25 09:28:02 +01:00

1.9 KiB
Raw Blame History

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!