Merge branch 'main' into dev

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# 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, 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][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+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,73 @@
+# Contributing Guidelines for BGmisc
+
+Thank you for considering contributing to BGmisc. This document outlines the process and best practices for contributing to this R package hosted on GitHub under the R Computing Lab.
+## Table of Contents
+
+1. [Code of Conduct](#code-of-conduct)
+2. [Getting Started](#getting-started)
+3. [Bug Reports](#bug-reports)
+4. [Feature Requests](#feature-requests)
+5. [Pull Requests](#pull-requests)
+6. [Code Style](#code-style)
+7. [Testing](#testing)
+8. [Documentation](#documentation)
+9. [Communication](#communication)
+
+## Code of Conduct
+
+All contributors are expected to adhere to the project's [Code of Conduct](https://github.com/R-Computing-Lab/BGmisc/blob/main/CODE_OF_CONDUCT.md). Please read it carefully before contributing.
+
+## Getting Started
+
+1. Fork the [BGmisc repository](https://github.com/R-Computing-Lab/BGmisc) to your GitHub account.
+2. Clone the forked repository to your local machine.
+3. Install the required packages and set up the development environment.
+
+## Bug Reports
+
+For reporting bugs, please create an issue in the GitHub repository. Make sure to:
+
+- Provide a clear title and description.
+- Include a minimal reproducible example.
+- Tag the issue with the "bug" label.
+
+## Feature Requests
+
+New features are welcome. To request a new feature:
+
+- Open an issue in the GitHub repository.
+- Clearly describe the feature and its potential benefits.
+- Tag the issue with the "feature request" label.
+
+## Pull Requests
+
+1. Fork the repository and create a new branch for your work.
+2. Commit your changes in logical chunks.
+3. Open a pull request with a clear title and description.
+4. Make sure all existing tests pass.
+5. Add new tests for your changes.
+
+## Code Style
+
+Follow the [Tidyverse Style Guide](https://style.tidyverse.org/) for R programming to maintain code consistency.
+
+## Testing
+
+- Tests are implemented using the `testthat` package.
+- Make sure to add new tests for any added functionality.
+- Run all tests to ensure that they pass before submitting a pull request.
+
+## Documentation
+
+- Update the README.Rmd and other relevant documentation.
+- Use [roxygen2](https://cran.r-project.org/web/packages/roxygen2/index.html) for documenting functions.
+- Include examples in the documentation where possible.
+
+## Communication
+
+- Use GitHub issues for all communication.
+- For more direct communication, you can [contact the maintainers](mailto:[email protected]).
+
+By contributing, you agree to abide by these guidelines and the project's [Code of Conduct](https://github.com/R-Computing-Lab/BGmisc/blob/main/CODE_OF_CONDUCT.md).
+
+Thank you for contributing to BGmisc!

README.Rmd

@@ -37,7 +37,8 @@ devtools::install_github("R-Computing-Lab/BGmisc")
 ```
 
 ## Contributing
-Contributions to the BGmisc project are welcome. Please submit issues and pull requests on the GitHub repository. For support, please use the GitHub issues page.
+Contributions to the BGmisc project are welcome. For guidelines on how to contribute, please refer to the [Contributing Guidelines](https://github.com/R-Computing-Lab/BGmisc/blob/main/CONTRIBUTING.md). Issues and pull requests should be submitted on the GitHub repository. For support, please use the GitHub issues page.
 
 ## License
 BGmisc is licensed under the GNU General Public License v3.0. For more details, see the [LICENSE.md](https://github.com/R-Computing-Lab/BGmisc/blob/main/LICENSE.md) file.
+```