Skip to contents

Contributing to rminka

Source: CONTRIBUTING.md

We love contributions! If you’re interested in helping to improve rminka, here’s how you can do it.

Have a question or an issue?

  • Report bugs: If you find a bug, please open an “Issue” on our GitHub repository. Include the rminka version, your R version, and a reproducible example of the problem.
  • Suggest features: If you have an idea for a new feature, you can also open an “Issue” to discuss it.

Want to contribute code?

Great! Follow these steps to submit a pull request:

  1. “Fork” this repository to your GitHub account.
  2. Clone your “fork” to your local machine.
  3. Create a new branch (git checkout -b feature/your-feature-name).
  4. Make your changes, ensure existing tests pass, and if adding new functionality, write tests for it.
  5. Make sure your code follows the package’s style (you can use styler::style_pkg()).
  6. “Commit” your changes (git commit -m "feat: description of the functionality").
  7. Push your branch to your “forked” repository (git push origin feature/your-feature-name).
  8. Open a “Pull Request” from your “fork” to the original rminka repository.

Code of Conduct

This project adheres to the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code.