Skip to content

Latest commit

 

History

History
140 lines (89 loc) · 4.2 KB

CONTRIBUTING.md

File metadata and controls

140 lines (89 loc) · 4.2 KB
Raw

Contributing to VECM

Thank you for taking the time to contribute to VECM, your support is appreciated.

Please read our Code of Conduct, avoid inappropriate behavior and respect the community.

How you can contribute

There are several ways to contribute to VECM. You can

  • Submit a bug report in an issue.

  • Propose an idea for a new feature in a discussion.

  • Improve the documentation.

Issue

Issues are used to track bugs, feature requests, and more.

To report a bug, please use our bug report template. It will help you give us all the information we need to fix the bug.

$\underline{\text{Attention!}}$ Before creating a new issue, check if a related issue already exists. You may find the GitHub search guide helpful.

If you have ideas for new features or want to improve the documentation, please do not submit an issue. Instead, follow the instructions in the sections below.

Discussion

The discussion forum is a place where you can ask questions, suggest ideas for new features, or give feedback.

When opening a discussion, please classify it by applying the correct label. The labels currently available are

  • 💬: feedback.
  • 🗣: general.
  • 🆘: help.
  • 💡: idea.

If you start a discussion to propose a new feature

  • Provide a clear and concise description of what the feature does.

  • Explain how to implement the feature. If it helps, you can include a draft of the code.

  • Highlight the advantages of the feature.

$\underline{\text{Attention!}}$ Until the feature is approved, pull requests related to it will not be accepted.

$\underline{\text{Attention!}}$ Your code should follow the tidyverse style guide.

Documentation

Good documentation helps users understand the package better.

There are several ways to contribute to the documentation. You can

  • Fix typos, spelling mistakes, or grammatical errors.

  • Improve the description of functions.

  • Propose better examples.

To implement any of the above, follow these steps:

  1. Go to the R folder in the code repository.

  2. Locate the file that contains the function you want to modify.

  3. Edit the file.

  4. Propose the file change.

$\underline{\text{Attention!}}$ When documenting functions, please use the roxygen2 comments together with the R Markdown syntax.

Pull request process

The pull request process consists of the following steps:

  1. Fork the repository into your GitHub account.

  2. Clone the forked repository to your local system.

Steps 1 and 2 can be implemented using the usethis::create_from_github(repo_spec = "github-repository", fork = TRUE) function.

  1. Install all development dependencies and make sure the package passes all checks.

Step 3 can be implemented by running devtools::install_dev_deps() and devtools::check() consecutively.

  1. Create a new branch for your pull request.

Step 4 can be implemented using the usethis::pr_init("github-branch-name") function.

  1. Make your changes.

  2. Commit and push the changes to GitHub.

Step 6 can be implemented by calling the usethis::pr_push() function and following the prompts in your browser.

$\underline{\text{Attention!}}$ The title of the pull request should briefly describe the changes you have made. If the pull request fixes an issue, the body of your pull request should also contain Fixes # (issue).

Inspiration

This contribution guide is inspired by the template of Peter Desmet and the template of the usethis package.

The bug report template builds on the Embedded Artistry’s template.