Skip to content

Latest commit

 

History

History
32 lines (22 loc) · 2.08 KB

CONTRIBUTING.md

File metadata and controls

32 lines (22 loc) · 2.08 KB

Contributing to Constellation UI Gallery

We welcome contributions to the Constellation UI Gallery repository.

All participants are expected to adhere to the Code of Conduct and treat each other with respect.

The following is a set of guidelines for contributing to this repository, which is hosted on GitHub.

How Can I Contribute?

Reporting Bugs

Bugs are tracked as GitHub issues. 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.
  • Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples.
  • 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.

Suggesting Enhancements or Proposing New Components

Both of these are tracked as GitHub issues.

  • 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.
  • 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 Atom which the suggestion is related to.
  • Explain why this enhancement would be useful to most Constellation UI applications.