diff options
| -rw-r--r-- | .remarkignore | 2 | ||||
| -rw-r--r-- | README.md | 49 |
2 files changed, 31 insertions, 20 deletions
diff --git a/.remarkignore b/.remarkignore new file mode 100644 index 0000000..4dd3757 --- /dev/null +++ b/.remarkignore @@ -0,0 +1,2 @@ +README.md +TODO.md diff --git a/README.md b/README.md index 41f20a1..98f823c 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ ricerlay ======== [](https://travis-ci.org/azahi/ricerlay) +[](https://www.codacy.com/manual/azahi/ricerlay?utm_source=github.com&utm_medium=referral&utm_content=azahi/ricerlay&utm_campaign=Badge_Grade) Purpose ------- @@ -18,15 +19,19 @@ Installing and Using With [layman](https://wiki.gentoo.org/wiki/Layman): - layman -a ricerlay - layman -S - emerge <package> +``` +layman -a ricerlay +layman -S +emerge <package> +``` With [eselect-repository](https://github.com/mgorny/eselect-repository): - eselect repository enable ricerlay - emerge --sync - emerge <package> +``` +eselect repository enable ricerlay +emerge --sync +emerge <package> +``` Getting Involved ---------------- @@ -50,27 +55,31 @@ be found [here](https://devmanual.gentoo.org/ebuild-writing/index.html). Example workflow could look like this (commented out are actions that you perform outside of your shell): - ### Fork this repository ### - git clone https://github.com/<your github username>/ricerlay.git - ### Make changes ### - ### Test build everything ### - ### Check for QA errors ### - git add <your changes> - git commit -m "<category>/<package>: <Briefly state your changes>" - git push -f origin master - ### Create a PR ### +``` +### Fork this repository ### +git clone https://github.com/<your github username>/ricerlay.git +### Make changes ### +### Test build everything ### +### Check for QA errors ### +git add <your changes> +git commit -m "<category>/<package>: <Briefly state your changes>" +git push -f origin master +### Create a PR ### +``` Consider commiting changes *per-package*, **don't** commit multiple packages at once. Make sure you write a **meaningful commit message** (you can use two or three words if you think that changes are self-explanatory), for example: - some-category/some-package: Briefly state yor changes +``` +some-category/some-package: Briefly state yor changes - If needed, explain the reasoning behind your commit or provide information, - changelog, upstream notes and etc. related to the packae in the subsection - of the commit message. Remember to reference GitHub tracked issues if you - are working on a fix, for example: Bug #420, Fixes #69. +If needed, explain the reasoning behind your commit or provide information, +changelog, upstream notes and etc. related to the packae in the subsection +of the commit message. Remember to reference GitHub tracked issues if you +are working on a fix, for example: Bug #420, Fixes #69. +``` Check your changes with `app-portage/repoman` and `app-portage/overlint` for possible QA errors. |