Skip to content

Latest commit

 

History

History
54 lines (32 loc) · 2.46 KB

CONTRIBUTING.md

File metadata and controls

54 lines (32 loc) · 2.46 KB

Contributing to ggcall

First off, thank you for considering contributing to ggcall. It's people like you that make ggcall such a great tool.

Where do I go from here?

If you've noticed a bug or have a feature request, make sure to open an issue. Here are a few important things you should know before reporting a bug:

  1. Make sure the bug was not already reported by searching on GitHub under Issues.
  2. If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample demonstrating the expected behavior that is not occurring.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for ggcall. Following these guidelines helps maintainers understand your report, reproduce the behavior, and find related reports.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for ggcall, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers understand your suggestion and make decisions.

Your First Code Contribution

Unsure where to begin contributing to ggcall? You can start by looking through these beginner and help-wanted issues:

  • Beginner issues - issues which should only require a few lines of code, and a test or two.
  • Help wanted issues - issues which should be a bit more involved than beginner issues.

Pull Requests

The process described here has several goals:

  • Maintain ggcall's quality
  • Fix problems that are important to users
  • Engage the community in working toward the best possible ggcall
  • Enable a sustainable system for ggcall's maintainers to review contributions

Please follow these steps to have your contribution considered by the maintainers:

  1. Follow the styleguides
  2. After you submit your pull request, verify that all status checks are passing

Styleguides

R Styleguide

All R code must adhere to the R style guide.

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 120 characters or less
  • Reference issues and pull requests liberally after the first line