Thank you for investing your time in contributing to the lavaan project!
Read our Code of Conduct to keep our community approachable and respectable.
In this small guide you will get an overview of the contribution workflow from opening an issue, creating a pull request (=PR), reviewing, and merging the PR.
Here are some resources to help you get started with open source contributions:
- Finding ways to contribute to open source on GitHub
- Set up Git
- GitHub flow
- Collaborating with pull requests
To understand how lavaan works and how the code base is organized, see this understanding_lavaan_internals.R document. When in doubt, feel free to contact the main developer.
If you have discovered a potential issue, check if the issue already exists. If not, you can open a new issue.
If you're unable to find an open issue addressing the problem, open an new issue. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring, or the feature that you are requesting.
Scan through our existing issues to find one that interests you. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.
- Fork the repository.
-
Using GitHub Desktop:
- Getting started with GitHub Desktop will guide you through setting up Desktop.
- Once Desktop is set up, you can use it to fork the repo!
-
Using the command line:
- Fork the repo so that you can make your changes without affecting the original project until you're ready to merge them.
- Create a working branch and start with your changes!
Commit the changes once you are happy with them.
When you're finished with the changes, create a pull request, also known as a PR.
- Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
- Don't forget to link PR to issue if you are solving one.
- Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, the lavaan maintainer will review your proposal. We may ask questions or request additional information.
- We may ask for changes to be made before a PR can be merged.
- As you update your PR and apply changes, mark each conversation as resolved.
- If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.