Skip to content

Latest commit

 

History

History
90 lines (57 loc) · 6.71 KB

CONTRIBUTING.md

File metadata and controls

90 lines (57 loc) · 6.71 KB
Raw

Contributing to generator-helix

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to generator-helix and its packages, which are hosted in the PentiaLabs on GitHub. These are just guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table Of Contents

What should I know before I get started?

How Can I Contribute?

What should I know before I get started?

Build with Yeoman

This project, generator-helix, is build with Yeoman. Yeoman helps you to kickstart new projects, prescribing best practices and tools to help you stay productive.

To do so, it provides a generator ecosystem. A generator is basically a plugin that can be run with the yo command to scaffold complete projects or useful parts.

Inside we're utilizing the "Yeoman workflow". This workflow is a robust and opinionated client-side stack, comprising tools and frameworks that can help developers quickly build applications. We take care of providing everything needed to get started without any of the normal headaches associated with a manual setup.

It would be wise to read up on the basics of Yeoman to get an understanding on the concepts before diving into contributing to the project.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for generator-helix. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻 💻, and find related reports 🔎.

When you are creating a bug report, please include as many details as possible. Fill out the required template, the information it asks for helps us resolve issues faster.

How Do I Submit A (Good) Bug Report?

Bugs are tracked as GitHub issues. Create an issue in this repository and provide the following information by filling in the template.

Explain the problem and include additional details to help maintainers reproduce the problem:

  • 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. For example, start by explaining how you started generator-helix, e.g. which command exactly you used in the terminal, or how you started it otherwise. When listing steps, don't just say what you did, but explain how you did it.
  • Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
  • 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. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.

Provide more context by answering these questions:

  • Did the problem start happening recently (e.g. after updating to a new version of generator-helix) or was this always a problem?
  • If the problem started happening recently, can you reproduce the problem in an older version of generator-helix? What's the most recent version in which the problem doesn't happen? You can download older versions of generator-helix from the releases page.
  • Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.

Include details about your configuration and environment:

  • What's the name and version of the OS you're using?
  • What's the version of node installed? You can get that number by running node --version.
  • What's the version of npm installed? You can get that number by running npm --version.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for generator-helix, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion 📝 and find related suggestions 🔎.

Fill in the template, including the steps that you imagine you would take if the feature you're requesting existed.

How Do I Submit A (Good) Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues. Create an issue in this repository 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. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • Include screenshots and animated GIFs which help you demonstrate the steps or point out the part of generator-helix which the suggestion is related to. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.
  • Explain why this enhancement would be useful to most generator-helix users.

Pull Requests

  • Write a convincing description of your PR and why it should land by filling in in the required template
  • Please check to make sure that there aren't existing pull requests attempting to address the issue mentioned.
  • Non-trivial changes should be discussed in an issue first.
  • Develop in a feature branch, not master.
  • Include screenshots and animated GIFs in your pull request whenever possible and neccessary.

Happy contributing! 🏩