Skip to content

Latest commit

聽

History

History
114 lines (70 loc) 路 5.2 KB

CONTRIBUTING.md

File metadata and controls

114 lines (70 loc) 路 5.2 KB
Raw

How to contribute to Changelog Reader Action

First off, thanks for taking the time to contribute!

This file is a set of guilines for contributing to 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.

All the contributors are/will be added to our Contributors Wall. If we forgot someone, please let us know. We'll be glad to add them to the list.

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 or talk about it on the community forum) 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.

Exepctions to Standard style:

  • We do not want space after function name function name(arg) { ... }

Additional rules:

  • Prefer spread operator (prefer-spread)
  • No useless brackets for arrow functions (arrow-body-style)
  • No useless parens for arrow functions (arrow-parens)
  • Require space before/after arrow function鈥檚 arrow (arrow-spacing)
  • switch must have a default case (default-case)
  • for...in loop must be guard by an if (guard-for-in)
  • Require space before the star of generator function (generator-star-spacing)
  • Getter properties must return a value (getter-return)
  • Compare to -0 is an error (no-compare-neg-zero)
  • Use brackets if arrow function body could be confused with comparisons (no-confusing-arrow)
  • No else when return is used (no-else-return)
  • No empty block statements (no-empty)
  • No type conversion with shorter notations (no-implicit-coercion)
  • No useless return statement (no-useless-return)
  • No redeclare variables (no-redeclare)
  • Using var statement is an error (no-var)
  • Prefer arrow function for callback (prefer-arrow-callback)
  • Prefer using constant (prefer-const)
  • Prefer rest parameter (prefer-rest-params)
  • Prefer using template literals (prefer-template)

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

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.