First of all, thank you for considering a contribution to actverse! Your interest and involvement are what make it rewarding for us—the project maintainers—to continue developing and improving actverse.
actverse 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.
Give It a Star ⭐
If you find actverse helpful, please consider starring the repository on GitHub. It helps others discover the project and shows your support!
Share actverse with Others 📣
Think actverse is useful? Let others discover it, by telling them in person, via Twitter or a blog post.
Sponsor actverse 💖
If you want to support actverse and its development, consider sponsoring the project. Your support helps us maintain and improve the project, and it allows us to dedicate more time to its development. Don’t forget to mention actverse in your sponsorship message.
Cite actverse in Your Work 📝
Are you using actverse in a publication or project? Please consider citing it. Citations help support the project and demonstrate its impact to the community.
Propose an Idea 💡
Have an idea for a new actverse feature? Take a look at the documentation and [issue list][issue] to see if it isn’t included or suggested yet. If not, suggest your idea as an [issue on GitHub][issue]. 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 actverse 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:
- The content of
utils::sessionInfo(). - Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug (Tip: Use the reprex package).
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!
The Website
This website is generated with pkgdown. That means we don’t have to write any HTML: Content is pulled together from documentation in the code, vignettes, Markdown files, the package DESCRIPTION and _pkgdown.yml settings. If you know your way around pkgdown, you can propose a file change to improve documentation.
Function Documentation
Functions are described as comments near their code and translated to documentation using roxygen2. If you want to improve a function description:
- Go to
R/directory in the code repository. - Look for the file with the function.
-
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 actverse? 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.
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.
Development Guidelines
We follow the GitHub flow for development. This means all changes should be made in feature branches, submitted as pull requests, and reviewed before merging into the main branch. Please keep your branches focused on a single topic or fix to make reviews easier and the project history clearer. Here are the steps to follow:
- Fork this repo and clone it to your computer. To learn more about this process, see this guide.
- 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 main. - Open the project in RStudio or other IDE of your choice.
- 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, warnings, and notes.
- Commit and push your changes.
- Submit a pull request.
Please ensure your code adheres to the tidyverse design guide and the tidyverse style guide. All contributions should follow these principles and conventions to maintain consistency and readability throughout the project.