CONTRIBUTING.md

In m-jahn/WeightedTreemaps: Generate and Plot Voronoi or Sunburst Treemaps from Hierarchical Data

Welcome to this repository's contributing guide

Thank you for investing your time in contributing to this project! All contributions are welcome as long as they serve to make this package safer, easier to use, more feature-rich and stable. Any contribution you make will be reflected on github.com/m-jahn/WeightedTreemaps.

Read the Code of Conduct to keep the developer community approachable and respectable.

In this guide you will get an overview of the contribution workflow from opening an issue, creating a pull request (PR), reviewing, and merging the PR.

New contributor guide

To get an overview of the project, read the README file. 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

Getting started

Issues

Create a new issue

If you spot a problem with this package, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.

Solve an issue

Scan through the existing issues to find one that interests you. You can narrow down the search using labels as filters. Issues can be assigned to specific contributors. You may still comment on these issues and make suggestions. If you find an open issue to work on, you are welcome to open a PR with a fix.

Make Changes

1. Fork the repository.
2. Using GitHub Desktop:
3. Getting started with GitHub Desktop will guide you through setting up Desktop.

4. Once Desktop is set up, you can use it to fork the repo!

5. Using the command line:

6. Fork the repo so that you can make your changes without affecting the original project until you're ready to merge them.

7. Clone your local fork of the repo using git: git clone https://github.com/<your_user_name>/WeightedTreemaps

8. Create a working branch and start with your changes (this section applies to a command line workflow)

9. Using git locally: git checkout -b newbranch

Commit your update

(this section applies to a command line workflow)

1. start making changes, and test them by checking that all examples from the vignette behave as expected.
2. For an R package, run R CMD CHECK or Build --> Check package in Rstudio. It should show no errors, ideally no warnings (except generic ones), and only negligible notes.
3. Commit the changes once you are happy with them using git add <my_changed_file> and then git commit -m "fix: that bug, closes #23". Don't forget to add a commit message that uses industry standard prefixes such as fix:, feat:, and docs:. Link the issue you are solving by using number tags (#23)
4. Push your changed branch to your own fork using git push origin newbranch

Pull Request

1. When you are happy with your changes, notify the other contributors/maintainers in the main repository's issue you like to solve.
2. If your contribution is deemed welcome and ready to be merged, create a pull request, also known as a PR. Do not request the main/master branch but the dev or other applicable feature branch to be used for merging. The main branch is protected and should only be merged from the WeightedTreemaps' dev.
3. Once you submit your PR, a maintainer will review your proposal. They may ask questions or request additional information.
4. Changes may be requested before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can also make changes in your fork, then commit them to your branch you like to merge. They will be automatically added to your PR.
5. As you update your PR and apply changes, mark each conversation as resolved.
6. If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.
7. If local checks pass and your PR adheres to all other standards, it will be merged into the dev branch.
8. If automatic checks from Github Actions workflows pass, it will be merged into the protected main/master branch.

Being a Contributor

1. You will be automatically added to the contributors page of this repository. Your profile picture will be visible on the front page.
2. Your contributions will show up on your Github activity profile.

Thank you for contributing to this package!

m-jahn/WeightedTreemaps documentation built on Dec. 15, 2024, 10:09 a.m.