Skip to content

Latest commit

 

History

History
145 lines (95 loc) · 4.41 KB

CONTRIBUTING.md

File metadata and controls

145 lines (95 loc) · 4.41 KB
Raw

CONTRIBUTING

Table of Contents

Welcome

When contributing to this repository, please first discuss the change you want to make via issue, @linterhub/maintainers, or use any other method before making a change.

Issue

If you have any questions, or you've found a bug or want to share any idea, please create the relevant issue in this repository.

Please take into account of our wishes for work with issues:

  • Use the GitHub issue search — to ensure that the issue hasn't been already reported.
  • The issue tracker shouldn't be used for personal support requests.

Reporting a bug

A bug is a demonstrable problem caused by the code in the repository. Thank you for essential bug reports!

Guidelines for bug reports:

  • Check if the issue has been fixed and try to reproduce it using the latest develop branch in the repository.
  • Isolate the problem by creating a test case and a live example.

A good bug report shouldn't leave others to need to reach you for more information. Please try to be as detailed as possible as all details listed will help us to fix the found issues.

Create issue: reporting a bug

Request a feature

We welcome feature requests but take some time to ensure that your idea fits with the scope and aims of our project. Please provide as much detail and context as possible.

Create issue: request a feature

Other questions

You can send you questions in @linterhub/maintens or create an issue: custom issue

Pull Request

Please reach us before submitting any significant pull request (e.g. implementing features, refactoring code), otherwise, you risk spending a lot of time working on something that is not likely to be merged into the project.

Please adhere to the coding conventions used throughout a project (indentation, accurate comments, etc.).

Follow this process if you want your work to be included in our project:

STEP 1: Fork and clone

Fork the linterhub/usage-parser repo and then clone it.

Note: More information about creating a fork and cloning your fork to local folder read in git help

STEP 2: Get the latest changes

git checkout develop

STEP 3: Install

npm install

STEP 4: Create a new branch

git checkout -b type/issue-short-name

Where:

  • type - is a semantic type for commits
  • issue-short-name - is a short name of issue. Please use - delimiters.

Note: Do not combine fixes for multiple issues into one branch

STEP 5: Make your changes

Make the changes, following the code conventions. Once you finished, run following command:

npm run test

If errors not found you can commit the changes to your branch:

git add -A .
git commit

Commit your changes using a descriptive commit message that follows our commit message conventions.

STEP 6: Double check your submission

Make sure your commit has the right format:

  • The commit message is properly formatted.
  • The change causes no functional regression. Be sure to run a test to verify your changes before submitting a pull request.
  • All changes must be accompanied by tests, even if the feature you’re working on previously had no tests.
  • All user-facing changes must be accompanied by the correspondent documentation.

STEP 7: Push your changes

git push

STEP 8: Send the pull request

Go to your fork in GitHub and then follow the GitHub documentation on how to send a pull request.

  • A pull request must contain a description explaining what you did and how the effects can be seen.