doc: add repo files & edit readme

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,28 @@
+---
+name: Bug report
+about: Standard bug report template
+title: ''
+labels: 'bug'
+---
+
+**Bug description**
+
+A clear and concise description of what the bug is.
+
+
+**Reproducible example**
+
+It is easier for developers to help if they can reproduce the problem.   
+Could you please provide a minimal reproducible example?
+
+
+**Additional context**
+
+Add any other context about the problem here.
+
+
+<details>
+```r
+# Output of sessionInfo()
+```
+</details>

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,10 @@
+---
+name: Feature request
+about: Standard feature request template
+title: ''
+labels: 'enhancement'
+---
+
+**Feature description**
+
+A clear and complete description of what the requested feature is.

.github/ISSUE_TEMPLATE/other_issue.md

@@ -0,0 +1,6 @@
+---
+name: Other issue
+about: Template for other issue types
+title: ''
+labels: ''
+---

CODE_OF_CONDUCT.md

@@ -0,0 +1,126 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at 
+<[email protected]>. 
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org),
+version 2.1, available at
+<https://www.contributor-covenant.org/version/2/1/code_of_conduct.html>.
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/inclusion).
+
+For answers to common questions about this code of conduct, see the FAQ at
+<https://www.contributor-covenant.org/faq>. Translations are available at
+<https://www.contributor-covenant.org/translations>.

CONTRIBUTING.md

@@ -0,0 +1,130 @@
+# Contributing to corpus-management
+
+First off, thanks for taking the time to contribute to `corpus-management`!
+
+All types of contributions are encouraged and valued. See the 
+[Table of contents](#table-of-contents) for different ways to help and details 
+about how this project handles them. Please make sure to read the relevant 
+section before making your contribution. It will make it a lot easier for us 
+maintainers and smooth out the experience for all involved.
+
+
+
+## Table of contents
+
+- [Code of conduct](#code-of-conduct)
+- [Style guide](#style-guide)
+- [Commit messages](#commit-messages)
+- [Asking questions](#asking-questions)
+- [Reporting bugs](#reporting-bugs)
+- [Requesting features](#requesting-features)
+- [Contributing code](#contributing-code)
+
+
+
+## Code of conduct
+
+This project is released with a [Contributor Code of Conduct](https://github.com/literaturesynthesis/corpus-management/blob/main/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to <[email protected]>.
+
+
+
+## Style guide
+
+We use the [Tidyverse style guide](https://style.tidyverse.org/) for writing R code. Functions are documented with the [roxygen2](https://roxygen2.r-lib.org/articles/roxygen2.html) syntax. `corpus-management` uses the `lower_snake_case`.
+
+
+
+## Commit messages
+
+If you want to contribute by commiting changes, please try to use the [Conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
+
+
+
+## Asking questions
+
+Before you ask a question, it is best to search for existing [Issues](https://github.com/literaturesynthesis/corpus-management/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue.
+
+If you then still feel the need to ask a question and need clarification, we recommend the following:
+
+- Open a new [Issue](https://github.com/literaturesynthesis/corpus-management/issues/new).
+- Use the template [other_issue.md](https://github.com/literaturesynthesis/corpus-management/blob/main/.github/ISSUE_TEMPLATE/other_issue.md).
+- Provide as much context as you can about what you're running into.
+- Provide project and platform versions (paste the output of `sessionInfo()`).
+
+We will then take care of the issue as soon as possible.
+
+
+
+## Reporting bugs
+
+
+
+### Before submitting a bug report
+
+A good bug report shouldn't leave others needing to chase you up for more  information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
+
+- Make sure that you are using the latest version of `corpus-management`.
+- Determine if your bug is really a bug and not an error on your side.
+- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/literaturesynthesis/corpus-management/issues?q=label%3Abug).
+
+
+
+### How do I submit a bug report?
+
+We use [GitHub Issues](https://github.com/literaturesynthesis/corpus-management/issues) to 
+track bugs and errors. If you run into an issue with the project:
+
+- Open a new [Issue](https://github.com/literaturesynthesis/corpus-management/issues/new).
+- Use the template [bug_report.md](https://github.com/literaturesynthesis/corpus-management/blob/main/.github/ISSUE_TEMPLATE/bug_report.md).
+- Explain the behavior you would expect and the actual behavior.
+- Please provide as much context as possible and describe the 
+*reproduction steps* that someone else can follow to recreate the issue on 
+their own. This usually includes your code with a reproducible example.
+
+We will then take care of the issue as soon as possible.
+
+
+
+## Requesting features
+
+
+
+### Before requesting a feature
+
+- Make sure that you are using the latest version of `corpus-management`.
+- Read the [documentation](https://github.com/literaturesynthesis/corpus-management/) carefully and find out if the functionality is already covered.
+- Perform a [search](https://github.com/literaturesynthesis/corpus-management/issues) to see if this enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
+
+
+
+### How do I submit a feature request?
+
+Feature requests are tracked as [GitHub Issues](https://github.com/literaturesynthesis/corpus-management/issues).
+
+- Open a new [Issue](https://github.com/literaturesynthesis/corpus-management/issues/new).
+- Use the template [feature_request.md](https://github.com/literaturesynthesis/corpus-management/blob/main/.github/ISSUE_TEMPLATE/feature_request.md).
+- Provide a clear and descriptive title for the issue to identify the suggestion.
+- Provide a step-by-step description of the suggested enhancement in as many details as possible.
+- Explain why this enhancement would be useful to most `corpus-management` users.
+
+We will then take care of the issue as soon as possible.
+
+
+
+## Contributing code
+
+We use the [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow) to collaborate on this project:
+
+
+1. [Fork](https://docs.github.com/en/get-started/quickstart/contributing-to-projects) this repository using the GitHub interface.
+1. [Clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) your fork using `git clone fork-url` (replace `fork-url` by the URL of your fork). Alternatively, open RStudio IDE and create a New Project from Version Control.
+1. Create a new branch w/ `git checkout -b branch-name` (replace `branch-name` by the name of your new branch).
+1. Make your contribution.
+1. Stage (`git add`) and commit (`git commit`) your changes as often as necessary
+1. Push your changes to GitHub w/ `git push origin branch-name`.
+3. Submit a [Pull Request](https://docs.github.com/en/get-started/quickstart/contributing-to-projects#making-a-pull-request) on the [original repo](https://github.com/literaturesynthesis/corpus-management/compare).
+
+We will then review the PR as soon as possible.
+
+
+**Thanks for your contribution!**