Skip to content

Latest commit

 

History

History
85 lines (46 loc) · 3.78 KB

CONTRIBUTING.md

File metadata and controls

85 lines (46 loc) · 3.78 KB
Raw

How to contribute to Conventional Changelog Reader Action

First off, thanks for taking the time to contribute!

This file is a set of guilines for contributing to Conventional Changelog Reader Action project. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table of contents

How can I contribute?

Styleguides

How can I contribute?

Did you find a bug?

  • Ensure the bug was not already reported by searching on GitHub under Issues.

  • 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 or an executable test case demonstrating the expected behavior that is not occurring.

  • If possible, use the relevant bug report templates to create the issue.

Did you write a patch that fixes a bug?

  • Write new unit test(s) that match the bug case to limit future regression.

  • Open a new GitHub pull request with the patch.

  • Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

  • Before submitting, please ensure your code follow the code convention.

Did you fix whitespace, format code, or make a purely cosmetic patch?

  • Your changes must follow the coding convention.

  • Please ensure that your changes does not include regression.

Do you intend to add a new feature or change an existing one?

  • Please ask first (open an issue before embarking on any significant pull request (e.g. implementing features, refactoring code), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.

  • Please adhere to the coding conventions used in this project (indentation, accurate comments, etc.) and any other requirements (such as test coverage, documentation).

Do you have questions about the source code?

Do you want to contribute to the Configfile documentation?

Documentation file are stored in the project source code.

  • Please refer to "Do you intend to add a new feature or change an existing one?" section.

Styleguides

JavaScript styleguide

All JavaScript must adhere to JavaScript Standard Style.

All the rules are listed in .eslintrc.json on the root directory.

Git commit messages

  • Use Conventional Commits specification

  • 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.