CONTRIBUTING.md

In AljosjaK/singcar: Comparing Single Cases to Small Samples

Contributing to singcar

First of all, thanks for considering contributing to singcar!

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

Code of conduct

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

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 singcar is useful? Let others discover it, by telling them in person, via Twitter or a blog post.

Using singcar for a paper you are writing? Consider citing it, e.g. by using utils::citation("singcar").

Ask a question️

Using singcar and got stuck? Browse the documentation or vignette to see if you can find a solution. Still stuck? Post your question as an issue on GitHub. I will try my best to address it.

Want to ask a question in private? Contact the package maintainer by email.

Feature suggestions

Have an idea for a new singcar feature? Take a look at the documentation and issue list to see if it isn't included or suggested yet. If not, suggest your idea as an issue on GitHub.

Report a bug or issue

Report bugs or issues as a new new issue in the issue tracker, so we can fix it. A good bug report makes it easier for us to do so, so please include:

• Your session info (e.g. using utils::sessionInfo()).
• Any details about your local setup that might be helpful in troubleshooting.
• Detailed (but minimal) steps to reproduce the bug, preferably with a reproducible example using reprex.

Improve the documentation

Noticed a typo in the vignette? 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 singcar? Have a look at the issue tracker, leave a comment on things you are working on and see the pull request guidelines below.

Pull request 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:
   • Write your code.
   • Test your code (bonus points for adding unit tests).
   • Document your code (see function documentation above).
   • Check your code with devtools::check() and aim for 0 errors and warnings.
5. Commit and push your changes.
6. Submit a pull request.

Reference

These contribution guidelines have been adopted and adapted from here.

AljosjaK/singcar documentation built on March 23, 2023, 1:40 p.m.