Skip to contents

Contributing to ukc19

Source: CONTRIBUTING.md

Thank you for your interest in contributing! ukc19 is released into the public domain under the MIT license, meaning it is free and unencumbered software. There are no copyright restrictions or complex licensing obligations for contributors or users.

Code of Conduct

Please note that the ukc19 project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.

How Can I Contribute?

We welcome contributions of all kinds! Here are a few ways you can help:

  • Reporting Bugs: Please open an issue on GitHub. Describe the bug, the steps to reproduce it, the expected behaviour, and the actual behaviour. Include details about your environment (R version, ukc19 version, OS).
  • Suggesting Enhancements: Have an idea for a new feature or an improvement? Open an issue to discuss it. We’re always looking for ways to make ukc19 better.
  • Improving Documentation: Is something unclear in the README, vignettes, or function documentation? Feel free to suggest edits or create a pull request.
  • Adding Vignettes or Examples: Demonstrating ukc19 with new use cases is incredibly valuable. Contributions in the form of vignettes are very welcome.
  • Submitting Code Changes: Fixes, new features, or performance improvements are all appreciated. Please submit a pull request (PR).

Pull Request Process

  1. Fork the Repository: Start by forking the ukc19 repository on GitHub to your own account.
  2. Create a Branch: Create a new branch for your specific feature or bug fix (e.g., fix-wasserstein-bug or add-new-plot).
  3. Make Changes: Implement your changes in your branch. Ensure your code follows R best practices and is well-documented.
  4. Test Your Changes: If you’re adding new functionality, include relevant tests. Make sure existing tests still pass (e.g., using devtools::test()).
  5. Commit Changes: Write clear, concise commit messages describing your changes.
  6. Submit a Pull Request: Push your branch to your fork and submit a pull request to the main ukc19 repository. Describe the changes made and link to any relevant issues.

Code Style and Licensing

  • Style: We generally follow the tidyverse style guide. Consistency is key. Code is formatted with AIR.
  • Licensing: By contributing code, documentation, or other materials to this repository, you agree to release your contributions under the same terms as the project itself. No formal copyright waiver is required beyond submitting the contribution under this understanding.

Thank you again for your interest! Your contributions help make ukc19 a valuable tool for the community.