Skip to content

Latest commit

 

History

History
93 lines (59 loc) · 4.47 KB

CONTRIBUTING.md

File metadata and controls

93 lines (59 loc) · 4.47 KB

Contributing to Auto PR Action

First off, thank you for considering contributing to Auto PR Action! It's people like you that make this tool better for everyone.

Code of Conduct

This project and everyone participating in it is governed by the Auto PR Action Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [INSERT EMAIL ADDRESS].

How Can I Contribute?

Reporting Bugs

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

Before Submitting A Bug Report

  • Check the issues for a list of current known issues.
  • Perform a cursory search to see if the problem has already been reported. If it has and the issue is still open, add a comment to the existing issue instead of opening a new one.

How Do I Submit A (Good) Bug Report?

Bugs are tracked as GitHub issues. Create an issue and provide the following information:

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible.
  • Provide specific examples to demonstrate the steps.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.
  • Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for Auto PR Action, including completely new features and minor improvements to existing functionality.

Before Submitting An Enhancement Suggestion

  • Check if there's already a similar suggestion which addresses your idea.
  • Perform a cursory search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.

How Do I Submit A (Good) Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues. Create an issue and provide the following information:

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Provide specific examples to demonstrate the steps.
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • Explain why this enhancement would be useful to most Auto PR Action users.

Pull Requests

The process described here has several goals:

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

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

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

Styleguides

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 72 characters or less
  • Reference issues and pull requests liberally after the first line

JavaScript Styleguide

  • Use semicolons ;
  • 2 spaces for indentation rather than tabs
  • You can try running npm run lint for style unification

Additional Notes

Issue and Pull Request Labels

This section lists the labels we use to help us track and manage issues and pull requests.

  • bug - Issues that are bugs.
  • enhancement - Issues that are feature requests.
  • documentation - Issues for improving or creating new documentation.
  • good first issue - Good for newcomers.

Thank You!

Your contributions to open source, large or small, make great projects like this possible. Thank you for taking the time to contribute.