Skip to content

Latest commit

 

History

History
166 lines (114 loc) · 9.23 KB

CONTRIBUTING.md

File metadata and controls

166 lines (114 loc) · 9.23 KB
Raw

Contributing to unmazedboot

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

The following is a set of guidelines for contributing to unmazedboot. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

This contributing doc is based on the CONTRIBUTING.md of Atom

Table Of Contents

Code of Conduct

Channels

How Can I Contribute?

Styleguides

Issue and Pull Request Labels

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct.

Channels

  • Join the unmazedboot Gitter Channels
    • Use the #general channel for general questions or discussion about unmazedboot
    • Use the #development channel for questions, discussion and suggestions about code and development

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for unmazedboot. 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.

Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.

How Do I Submit A (Good) Bug Report?

Bugs are tracked as GitHub issues. Create an issue on that 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
  • 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.
  • If the problem wasn't triggered by a specific action, describe what you were doing before the problem happened and share more information using the guidelines below.

Include details about your configuration and environment:

  • Which version of unmazedboot are you using?
  • What's the name and version of the OS you're using?
  • What are the version of the docker and docker-compose you're using?

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for unmazedboot, 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 🔎.

When you are creating an enhancement suggestion, please include as many details as possible. 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 on that 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 unmazedboot 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 unmazedboot users.
  • List some other tools or applications where this enhancement exists.
  • Specify which version of unmazedboot you're using.
  • Specify the name and version of the OS you're using.

Code Contribution

Local development

Make sure you have latest docker for desktop installed.

  • Clone the repo to your machine (or fork it to your github account then clone from there)
git clone git@github.com:intuit/unmazedboot.git
cd unmazedboot

  • Make your branch from develop with git checkout develop

  • Install all dependencies then docker-compose build --pull

Pull Requests

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Try to limit the length of commit message
  • Reference issues and pull requests liberally after the first line, if applicable
  • Consider starting the commit message with an applicable emoji:
    • 🎨 :art: when improving the format/structure of the code
    • 🐎 :racehorse: when improving performance
    • 🚱 :non-potable_water: when plugging memory leaks
    • 📝 :memo: when writing docs
    • 🐧 :penguin: when fixing something on Linux
    • 🍎 :apple: when fixing something on macOS
    • 🏁 :checkered_flag: when fixing something on Windows
    • 🐛 :bug: when fixing a bug
    • 🔥 :fire: when removing code or files
    • 💚 :green_heart: when fixing the CI build
    • ✅ :white_check_mark: when adding tests
    • 🔒 :lock: when dealing with security
    • ⬆️ :arrow_up: when upgrading dependencies
    • ⬇️ :arrow_down: when downgrading dependencies
    • 👕 :shirt: when removing linter warnings

Dockerfile Linter

All Dockerfile is validated with Hadolint. Make sure to disable the things you need to get a clean build.

Issue and Pull Request Labels

This section lists the labels we use to help us track and manage issues and pull requests.

The labels are loosely grouped by their purpose, but it's not required that every issue have a label from every group or that an issue can't have more than one label from the same group.

Please open an issue if you have suggestions for new labels.

Type of Issue and Issue State

Label name Description
enhancement Feature requests.
bug Confirmed bugs or reports that are very likely to be bugs.
question Questions more than bug reports or feature requests (e.g. how do I do X).
feedback General feedback more than bug reports or feature requests.
help-wanted The team would appreciate help from the community in resolving these issues.
more-information-needed More information needs to be collected about these problems or feature requests (e.g. steps to reproduce).
needs-reproduction Likely bugs, but haven't been reliably reproduced.
blocked Issues blocked on other issues.
duplicate Issues which are duplicates of other issues, i.e. they have been reported before.
wontfix The team has decided not to fix these issues for now, either because they're working as intended or for some other reason.
invalid Issues which aren't valid (e.g. user errors).
documentation Documentation needed or certain part needs to be further explained.