Skip to contents

Contributing to GLBFP

Source: CONTRIBUTING.md

Thank you for considering contributing to GLBFP! 🎉 We welcome all contributions, whether it’s fixing a bug, improving documentation, or adding new features.

🛠 How to Contribute

1. Fork the Repository

Click the Fork button at the top right of this repository to create a copy of it in your GitHub account.

2. Clone Your Fork

Download your forked repository to your local machine:

git clone https://github.com/AurelienNicosiaUlaval/GLBFP.git
cd GLBFP

Replace AurelienNicosiaUlaval with your actual GitHub username.

3. Create a New Branch

Before making any changes, create a new branch:

git checkout -b feature-your-feature-name

Use a descriptive name for your branch.

4. Make Your Changes

  • Add or edit functions in the R/ directory.
  • Update documentation if necessary (README.md or man/ folder).
  • Run tests (devtools::test()) to ensure everything works.

5. Commit Your Changes

Once your changes are ready, commit them:

git add .
git commit -m "Brief description of the changes"

6. Push to Your Fork

Upload your changes to your GitHub fork:

git push origin feature-your-feature-name

7. Open a Pull Request

Go to the original repository and click on New Pull Request. Select your fork and branch, and describe your changes.

✅ Contribution Guidelines

  • Follow the tidyverse style guide for R code.
  • Document all new functions using roxygen2 format.
  • Ensure all tests pass before submitting a PR.
  • Be respectful and collaborative.

📝 Reporting Issues

If you find a bug or want to request a new feature, please open an issue on GitHub Issues.

We appreciate your help in improving GLBFP! 🚀