Alter formatting, add contribution information
This commit is contained in:
parent
5c1884f059
commit
04d1bb390b
2 changed files with 34 additions and 16 deletions
|
@ -1,19 +1,37 @@
|
||||||
***footnotes*** welcomes contributions!
|
**footnotes** welcomes contributions!
|
||||||
|
|
||||||
Please follow these guidelines when contributing, as it will give your pull request the best chance of being accepted:
|
Please follow these guidelines when contributing, as it will give your pull
|
||||||
|
request the best chance of being accepted:
|
||||||
|
|
||||||
# Branching
|
# Requesting Features/Reporting Bugs
|
||||||
|
|
||||||
- ***footnotes*** uses [GitHub Flow](https://githubflow.github.io/)
|
- To request a new feature or to report a bug, create an
|
||||||
- branch off of `main` to start developing
|
[Issue](https://github.com/markcheret/footnotes/issues/new/choose) and choose
|
||||||
- give your new branch a descriptive name
|
the correct template
|
||||||
- when ready, submit a pull request to merge your branch with `main`
|
|
||||||
|
# Contributing Code
|
||||||
|
|
||||||
|
- **footnotes** uses [GitHub Flow](https://githubflow.github.io/)
|
||||||
|
- 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](https://github.com/markcheret/footnotes/compare)
|
||||||
|
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
|
||||||
|
assigned to a Project board, this will automatically move it and any related
|
||||||
|
Issues into the ‘Review in progress’ bucket
|
||||||
|
|
||||||
# Commits
|
# Commits
|
||||||
|
|
||||||
- ***footnotes*** uses [Conventional Commits](https://www.conventionalcommits.org)
|
- **footnotes** uses [Conventional Commits](https://www.conventionalcommits.org)
|
||||||
- keep individual commits as small as possible
|
- keep individual commits as small as possible
|
||||||
|
|
||||||
# Versioning
|
# Versioning
|
||||||
|
|
||||||
- ***footnotes*** uses [Semantic Versioning](https://semver.org/)
|
- **footnotes** uses [Semantic Versioning](https://semver.org/)
|
||||||
|
|
||||||
|
# Translating
|
||||||
|
|
||||||
|
- Translations are welcome!
|
||||||
|
|
14
README.md
14
README.md
|
@ -6,9 +6,9 @@
|
||||||
|
|
||||||
Featured on [wpmudev](http://premium.wpmudev.org/blog/12-surprisingly-useful-wordpress-plugins-you-dont-know-about/) --- cheers for the review, folks!
|
Featured on [wpmudev](http://premium.wpmudev.org/blog/12-surprisingly-useful-wordpress-plugins-you-dont-know-about/) --- cheers for the review, folks!
|
||||||
|
|
||||||
***footnotes*** aims to be the all-in-one solution for displaying an automatically generated list of references on your Page or Post. The Plugin ships with a set of current defaults but also empowers you to control how your footnotes are being displayed.
|
**footnotes** aims to be the all-in-one solution for displaying an automatically generated list of references on your Page or Post. The Plugin ships with a set of current defaults but also empowers you to control how your footnotes are being displayed.
|
||||||
|
|
||||||
***footnotes*** gives you the ability to display well-formatted footnotes on your WordPress Pages and Posts—those footnotes we know from offline publishing.
|
**footnotes** gives you the ability to display well-formatted footnotes on your WordPress Pages and Posts—those footnotes we know from offline publishing.
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
|
@ -39,13 +39,13 @@ Unit tests are TODO.
|
||||||
|
|
||||||
## Main Features
|
## Main Features
|
||||||
|
|
||||||
- Fully customizable ***footnotes*** start and end shortcodes;
|
- Fully customizable **footnotes** start and end shortcodes;
|
||||||
- Styled tooltips supporting hyperlinks display ***footnotes*** or a dedicated text;
|
- Styled tooltips supporting hyperlinks display **footnotes** or a dedicated text;
|
||||||
- Responsive *Reference Container* at the end or positioned by shortcode;
|
- Responsive *Reference Container* at the end or positioned by shortcode;
|
||||||
- Display the ***footnotes*** *Reference Container* inside a Widget;
|
- Display the **footnotes** *Reference Container* inside a Widget;
|
||||||
- Wide choice of numbering styles;
|
- Wide choice of numbering styles;
|
||||||
- Freely configurable and optional backlink symbol;
|
- Freely configurable and optional backlink symbol;
|
||||||
- Configure the ***footnotes'*** appearance by dashboard settings and Custom CSS style rules;
|
- Configure the **footnotes'** appearance by dashboard settings and Custom CSS style rules;
|
||||||
- Button in both the Visual and the Text editor to add shortcodes around selection.
|
- Button in both the Visual and the Text editor to add shortcodes around selection.
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
@ -63,4 +63,4 @@ The current version is available on the [WordPress.org Plugin Directory](https:/
|
||||||
|
|
||||||
## Acknowledgements
|
## Acknowledgements
|
||||||
|
|
||||||
Huge thanks to every ***footnotes user***, contributor, bug reporter, feature requester and fan!
|
Huge thanks to every **footnotes user**, contributor, bug reporter, feature requester and fan!
|
||||||
|
|
Reference in a new issue