Skip to contents

Contributing to asar

Source: CONTRIBUTING.md

Do you have an idea that would improve asar? Consider making a contribution! We welcome ideas for improving not only our code, but also our documentation, tutorial, and any other material associated with asar. Here are some options and tips for doing so.

Note: To make any contribution, you must agree to abide by the Code of Conduct.

Contributing ideas: code, documentation, etc.

Recommended workflow: fork & submit a pull request

The most efficient way to contribute an idea is to fork asar, make your suggested changes on a local branch, and then submit a pull request. This will allow the developers to easily evaluate your suggested changes. Please see the GitHub Docs’ “Contributing to a project” page for step-by-step guidance in using this workflow.

  • Write clear, succinct commit messages (see some tips here)
  • Limit a commit to a few, rather than many, changes. Smaller commits means more commit messages, which is often helpful for documentation.
  • Ensure your base branch is correct. We typically merge most PRs into “dev”, then merge “dev” into “main” upon a new release.
  • Test that your contributed code will function as expected under different circumstances.
  • Add comments to the code if it’s not immediately clear what the purpose of the code is, or how it works.

Contributing bugs

Found a bug? Tell us about it on our Issues page. Before you create an issue, please check that it has not already been resolved (i.e., is a “closed” issue) or documented in our Frequently Asked Questions (FAQ) vignette.

If possible, please submit a reproducible example (reprex) to help us understand the problem better and, ideally, allow us to reproduce your issue.

Contributing questions

Have a question? Ask it in our Discussions page. You can categorize it under General, Ideas, Q&A, and more.