Skip to content

Latest commit

 

History

History
54 lines (34 loc) · 2.62 KB

CONTRIBUTING.md

File metadata and controls

54 lines (34 loc) · 2.62 KB

Contributing to DiagnoseMe

First off, thank you for considering contributing to DiagnoseMe. It's people like you that make DiagnoseMe such a great tool.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for DiagnoseMe. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

  • 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.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for DiagnoseMe, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion and make decisions.

  • 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.
  • Describe the current behavior and explain which behavior you expected to see instead and why.

Pull Requests

  • Fill in the required template
  • Do not include issue numbers in the PR title
  • Include screenshots and animated GIFs in your pull request whenever possible.
  • End all files with a newline

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

JavaScript Styleguide

All JavaScript must adhere to JavaScript Standard Style.

CSS Styleguide

  • Use hyphen-delimited class and id names.
  • End all files with a newline
  • Place CSS properties in alphabetical order
  • Use 4 spaces for indentation

Code of Conduct

This project and everyone participating in it is governed by the DiagnoseMe Code of Conduct. By participating, you are expected to uphold this code. Please don't hesitate to report any unacceptable behavior.