Badges and contribution guidelines (#200)

Add a bunch of badges and update the standard contribution guidelines.

Signed-off-by: Dinakar <[email protected]>
Co-authored-by: cicdguy <[email protected]>

.github/CONTRIBUTING.md

@@ -16,7 +16,7 @@ Your input is deeply valued, whether an issue, a pull request, or even feedback,
 
 [🚩 Pull requests](#pull-requests)
 
-[👗 Style guide](#style-guide)
+[💻 Coding guidelines](#coding-guidelines)
 
 [🏆 Recognition model](#recognition-model)
 
@@ -42,32 +42,32 @@ For new feature requests, please elaborate on the context and the benefit the fe
 
 ## Pull requests
 
-### Github flow
+### Github Flow
 
-This repository uses the [Github flow](https://docs.github.com/en/get-started/quickstart/github-flow) model for collaboration. To submit a pull request:
+This repository uses the [Github Flow](https://docs.github.com/en/get-started/quickstart/github-flow) model for collaboration. To submit a pull request:
 
-1. Create a branch.
+1. Create a branch
 
    Please see the [branch naming convention](#branch-naming-convention) below. If you don't have write access to this repository, please fork it.
 
-2. Make changes.
+2. Make changes
 
-    Make sure your code:
+    Make sure your code
     * passes all checks imposed by GitHub Actions
     * is well documented
     * is well tested with unit tests sufficiently covering the changes introduced
 
-3. Create a pull request (PR).
+3. Create a pull request (PR)
 
    In the pull request description, please link the relevant issue (if any), provide a detailed description of the change, and include any assumptions.
 
-4. Address review comments, if any.
+4. Address review comments, if any
 
-5. Receive an approval.
+5. Post approval
 
    Merge your PR if you have write access. Otherwise, the reviewer will merge the PR on your behalf.
 
-6. Pat yourself on the back.
+6. Pat yourself on the back
 
    Congratulations! 🎉
    You are now an official contributor to this project! We are grateful for your contribution.
@@ -84,6 +84,22 @@ Sometimes you might need to change upstream dependent package(s) to be able to s
 
 Please refer to the [staged.dependencies package documentation](https://openpharma.github.io/staged.dependencies/) for more details.
 
+## Coding guidelines
+
+This repository follows some unified processes and standards adopted by its maintainers to ensure software development is carried out consistently within teams and cohesively across other repositories.
+
+### Style guide
+
+This repository follows the standard [`tidyverse` style guide](https://style.tidyverse.org/) and uses [`lintr`](https://github.com/r-lib/lintr) for lint checks. Customized lint configurations are available in this repository's `.lintr` file.
+
+### Dependency management
+
+Lightweight is the right weight. This repository follows [tinyverse](https://www.tinyverse.org/) recommedations of limiting dependencies to minimum.
+
+### Dependency version management
+
+If the code is not compatible with all (!) historical versions of a given dependenct package, it is required to specify minimal version in the `DESCRIPTION` file. In particular: if the development version requires (imports) the development version of another package - it is required to put `abc (>= 1.2.3.9000)`.
+
 ### Recommended development environment & tools
 
 #### R & package versions
@@ -98,10 +114,6 @@ We highly recommend that you use the [`pre-commit`](https://pre-commit.com/) too
 
 Pre-commit hooks are already available in this repository's `.pre-commit-config.yaml` file.
 
-## Style guide
-
-This repository follows the standard [`tidyverse` style guide](https://style.tidyverse.org/) and uses [`lintr`](https://github.com/r-lib/lintr) for lint checks. Customized lint configurations are available in this repository's `.lintr` file.
-
 ## Recognition model
 
 As mentioned previously, all contributions are deeply valued and appreciated. While all contribution data is available as part of the [repository insights][insights], to recognize a _significant_ contribution and hence add the contributor to the package authors list, the following rules are enforced:
@@ -118,8 +130,7 @@ The package maintainer also reserves the right to adjust the criteria to recogni
 If you have further questions regarding the contribution guidelines, please contact the package/repository maintainer.
 
 <!-- urls -->
-[issues]: https://github.com/insightsengineering/teal.osprey/issues
 [docs]: https://insightsengineering.github.io/teal.osprey/index.html
-[articles]: https://insightsengineering.github.io/teal.osprey/articles/index.html
-[license]: https://insightsengineering.github.io/teal.osprey/LICENSE-text.html
+[articles]: https://insightsengineering.github.io/teal.osprey/main/articles/index.html
+[license]: https://insightsengineering.github.io/teal.osprey/main/LICENSE-text.html
 [insights]: https://github.com/insightsengineering/teal.osprey/pulse

README.md

@@ -1,7 +1,22 @@
 # teal.osprey
 
 <!-- start badges -->
-[![Code Coverage](https://raw.githubusercontent.com/insightsengineering/teal.osprey/_xml_coverage_reports/data/main/badge.svg)](https://raw.githubusercontent.com/insightsengineering/teal.osprey/_xml_coverage_reports/data/main/coverage.xml)
+[![Check 🛠](https://github.com/insightsengineering/teal.osprey/actions/workflows/check.yaml/badge.svg)](https://github.com/insightsengineering/teal.osprey/actions/workflows/check.yaml)
+[![Docs 📚](https://github.com/insightsengineering/teal.osprey/actions/workflows/docs.yaml/badge.svg)](https://insightsengineering.github.io/teal.osprey/)
+[![Code Coverage 📔](https://raw.githubusercontent.com/insightsengineering/teal.osprey/_xml_coverage_reports/data/main/badge.svg)](https://raw.githubusercontent.com/insightsengineering/teal.osprey/_xml_coverage_reports/data/main/coverage.xml)
+
+![GitHub forks](https://img.shields.io/github/forks/insightsengineering/teal.osprey?style=social)
+![GitHub Repo stars](https://img.shields.io/github/stars/insightsengineering/teal.osprey?style=social)
+
+![GitHub commit activity](https://img.shields.io/github/commit-activity/m/insightsengineering/teal.osprey)
+![GitHub contributors](https://img.shields.io/github/contributors/insightsengineering/teal.osprey)
+![GitHub last commit](https://img.shields.io/github/last-commit/insightsengineering/teal.osprey)
+![GitHub pull requests](https://img.shields.io/github/issues-pr/insightsengineering/teal.osprey)
+![GitHub repo size](https://img.shields.io/github/repo-size/insightsengineering/teal.osprey)
+![GitHub language count](https://img.shields.io/github/languages/count/insightsengineering/teal.osprey)
+[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
+[![Current Version](https://img.shields.io/github/r-package/v/insightsengineering/teal.osprey/main?color=purple\&label=package%20version)](https://github.com/insightsengineering/teal.osprey/tree/main)
+[![Open Issues](https://img.shields.io/github/issues-raw/insightsengineering/teal.osprey?color=red\&label=open%20issues)](https://github.com/insightsengineering/teal.osprey/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)
 <!-- end badges -->
 
 The teal.osprey package provides community contributed `teal` modules of the analysis functions from the [osprey](https://insightsengineering.github.io/osprey/) R package.

inst/WORDLIST

@@ -2,13 +2,15 @@ ADSL
 ADaM
 AE
 CTCAE
+Forkers
+Github
 Hou
 Lil
 NCI
 PCHG
+Repo
 Swimlane
 TLG
-Github
 TLGs
 UI
 Xuefeng
@@ -20,8 +22,7 @@ liaoc
 lil
 pre
 qit
+repo
 swimlane
 ui
 zhanc
-repo
-Forkers