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
This commit is contained in:
GitHub
parent
e780d817c1
commit
6a1117be15
183 changed files with 9761 additions and 2941 deletions
|
|
@ -1,43 +1,50 @@
|
|||
# **footnotes** Contributing Guide
|
||||
|
||||
**footnotes** welcomes contributions!
|
||||
|
||||
Please follow these guidelines when contributing, as it will give your pull
|
||||
request the best chance of being accepted:
|
||||
## Code of Conduct
|
||||
|
||||
# Requesting Features/Reporting Bugs
|
||||
Please read and ensure that you adhere to the project's [Code of Conduct][coc].
|
||||
|
||||
- To request a new feature or to report a bug, create an [Issue][new-issue] and
|
||||
choose the correct template
|
||||
## Requesting Features/Reporting Bugs
|
||||
|
||||
# Contributing Code
|
||||
To request a new feature or to report a bug, create an [Issue][new-issue] and
|
||||
choose the correct template.
|
||||
|
||||
- **footnotes** uses [GitHub Flow][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][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
|
||||
- when you think you're finished, un-draft your pull request — if the PR is
|
||||
## Contributing Code
|
||||
|
||||
- **footnotes** uses [GitHub Flow][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][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
|
||||
Issues into the ‘Review in progress’ bucket.
|
||||
|
||||
# Commits
|
||||
## Commits
|
||||
|
||||
- **footnotes** uses [Conventional Commits][conventional-commits]
|
||||
- we use [PHP Commitizen][php-commitizen] to automate this - use `composer commit`
|
||||
- keep individual commits as small as possible
|
||||
- **footnotes** uses the [Conventional Commits][conventional-commits] for
|
||||
commit message formatting;
|
||||
- we recommend using [Commitizen][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
|
||||
## Versioning
|
||||
|
||||
- **footnotes** uses [Semantic Versioning][semver]
|
||||
**footnotes** uses [WordPress Versioning][wpver].
|
||||
|
||||
# Translating
|
||||
## Translating
|
||||
|
||||
- Translations are welcome!
|
||||
Translations are welcome!
|
||||
|
||||
[coc]: https://github.com/markcheret/footnotes/blob/main/CODE_OF_CONDUCT.md
|
||||
[new-issue]: https://github.com/markcheret/footnotes/issues/new/choose
|
||||
[github-flow]: https://githubflow.github.io/
|
||||
[pull-request]: https://github.com/markcheret/footnotes/compare
|
||||
[conventional-commits]: https://www.conventionalcommits.org
|
||||
[php-commitizen]: https://github.com/conventional-commits/php-commitizen
|
||||
[semver]: https://semver.org/
|
||||
[commitizen]: https://www.npmjs.com/package/commitizen
|
||||
[wpver]: https://make.wordpress.org/core/handbook/about/release-cycle/version-numbering/
|
||||
|
|
|
|||
Reference in a new issue