Merge pull request #28 from markcheret/footnotes-emphasis

Emphasise plugin name, add contributing guidelines

CONTRIBUTING.md

@@ -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
 
-- footnotes uses [Conventional Commits](https://www.conventionalcommits.org)
+- **footnotes** uses [Conventional Commits](https://www.conventionalcommits.org)
 - keep individual commits as small as possible
 
 # Versioning
 
-- footnotes uses [Semantic Versioning](https://semver.org/)
+- **footnotes** uses [Semantic Versioning](https://semver.org/)
+
+# Translating
+
+- Translations are welcome!

README.md

@@ -13,12 +13,12 @@ Featured on [wpmudev](http://premium.wpmudev.org/blog/12-surprisingly-useful-wor
 ## Getting Started
 
 1. Read the contributing guidelines
-1. Clone this repository (`git clone git@github.com:Rumperuu/footnotes.git`)
+1. Clone this repository (`git clone git@github.com:markcheret/footnotes.git`)
 1. Install [Composer](https://getcomposer.org/download/), if you don't have it already
 1. Install dependencies (`composer install`)
 1. Create a new branch from `main` (`git checkout -b <your-descriptive-branch-name>`)
 1. When you're finished, commit your changes to the remote version of your branch
-   and submit a [pull request](https://github.com/Rumperuu/footnotes/pulls).
+   and submit a [pull request](https://github.com/markcheret/footnotes/pulls).
 
 ## Checking WP Coding Standard Compliance
 
@@ -45,7 +45,7 @@ Unit tests are TODO.
 - Display the **footnotes** *Reference Container* inside a Widget;
 - Wide choice of numbering styles;
 - 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.
 
 ## Example Usage
@@ -63,4 +63,4 @@ The current version is available on the [WordPress.org Plugin Directory](https:/
 
 ## 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!