Skip to content

Latest commit

 

History

History
45 lines (35 loc) · 2.18 KB

CONTRIBUTING.md

File metadata and controls

45 lines (35 loc) · 2.18 KB
Raw

Contributing to plain-html-webpack-starter

Thank you for taking interest in contributing to this project, we are happy yo have you here!

Following is a small set of guidelines on how to contribute to this project. Feel free to suggest changes to this document as well, adding guidelines as needed. Remember that guidelines are not rules and therefore it's not a must to follow them. See them as help to get you started!

Before you start

This is currently a very small project and don't need much of an introduction if you have read the readme, otherwise do that first!

Contributing

Reporting a bug

Bug reports are tracked as Github issues. Please read through the following section before reporting a bug to provide a good bug report.

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem. Please be as detailed as possible.
  • Provide a code example whre the bug is triggered. If using snippets, use markdown to highlight the code.
  • Describe the observed behavior after following the steps and what the problem is.
  • Explain the expected behavior and what you see instead.
  • Include screenshots and/or animating gifs where you show how to reproduce the bug.

Suggesting enhancement

Enhancement suggestions are tracked as Github issues. Please read through the following section before adding a enhancement suggestion.

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • Explain why this enhancement would be useful to most plain-html-webpack-starter users.

Pull Requests

Local development

  1. Clone/Fork the repo.
  2. Run "npm install" in the root folder.
  3. Run "npm run start:dev" to start the dev server.

Think about the following when writing your commit message:

  • Use the present tense ("Add feature", not "Added feature") and imperative mood ("Change image to", not "Changes image to")
  • Limit the first line to 72 characters or less
  • If the commit is in need of a description, do a newline between the first line and the description
  • Reference issues and pull requests in the description