.github/contributing.md

In susjoh/genedroppeR: genedroppeR: conduct single-locus genedrop analyses through pedigrees

Contributing to our_package

Thank you for considering contributing to genedroppeR.

genedroppeR is an open source project, maintained by people who care. We are not directly funded to do so.

How you can contribute

There are several ways you can contribute to this project. If you want to know more about why and how to contribute to open source projects like this one, see this Open Source Guide.

Share the love ❤️

Think genedroppeR is useful? Let others discover it, by telling them in person, via Twitter or a blog post.

Using genedroppeR for a paper you are writing? Consider [citing it][citation].

Ask a question ⁉️

Using genedroppeR and got stuck? Browse the [documentation][http://github.com/susjoh/genedroppeR] to see if you can find a solution. Still stuck? Post your question as an issue on GitHub. While we cannot offer user support, we'll try to do our best to address it, as questions often lead to better documentation or the discovery of bugs.

Want to ask a question in private? Contact the package maintainer by email[mailto:[e-mail]].

Propose an idea 💡

Have an idea for a new our_package feature? Take a look at the [documentation][http://github.com/susjoh/genedroppeR] and issue list to see if it isn't included or suggested yet. If not, suggest your idea as an issue on GitHub. While we can't promise to implement your idea, it helps to:

• Explain in detail how it would work.
• Keep the scope as narrow as possible.

See below if you want to contribute code for your idea as well.

Report a bug 🐛

Using our_package and discovered a bug? That's annoying! Don't let others have the same experience and report it as an issue on GitHub so we can fix it. A good bug report makes it easier for us to do so, so please include:

• Your operating system name and version (e.g. Mac OS 10.13.6).
• Any details about your local setup that might be helpful in troubleshooting.
• Detailed steps to reproduce the bug.

Improve the documentation 📖

Noticed a typo on the website? Think a function could use a better example? Good documentation makes all the difference, so your help to improve it is very welcome!

Function documentation

Functions are described as comments near their code and translated to documentation using roxygen2. If you want to improve a function description:

1. Go to R/ directory in the code repository.
2. Look for the file with the name of the function.
3. Propose a file change to update the function documentation in the roxygen comments (starting with #').

Contribute code 📝

Care to fix bugs or implement new functionality for our_package? Awesome! 👏 Have a look at the issue list and leave a comment on the things you want to work on. See also the development guidelines below.

Development guidelines

We try to follow the GitHub flow for development.

1. Fork this repo and clone it to your computer. To learn more about this process, see this guide.
2. If you have forked and cloned the project before and it has been a while since you worked on it, pull changes from the original repo to your clone by using git pull upstream master.
3. Open the RStudio project file (.Rproj).
4. Make your changes:
5. Write your code.
6. Test your code (bonus points for adding unit tests).
7. Document your code (see function documentation above).
8. Check your code with devtools::check() and aim for 0 errors and warnings.
9. Commit and push your changes.
10. Submit a pull request.

susjoh/genedroppeR documentation built on Sept. 9, 2024, 3:19 a.m.