Skip to content

Latest commit

 

History

History
110 lines (65 loc) · 6.14 KB

CONTRIBUTING.md

File metadata and controls

110 lines (65 loc) · 6.14 KB

Contributing to Smart Units Converter

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

The following is a set of guidelines for contributing to Smart Units Converter, which are hosted in the Smart Units Converter on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table Of Contents

Code of Conduct

How Can I Contribute? Reporting Bugs Suggesting Enhancements Your First Code Contribution Pull Requests

Styleguides Git Commit Messages

Code of Conduct

This project and everyone participating in it is governed by the Smart Units Converter. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

What should I know before I get started

This is a test repository, but feel free to file an issue if you still need to.

How Can I Contribute

Reporting Bugs

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

Before creating bug reports, please check if that bug is already reported as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible.

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 the repository and provide as much information as you can provide, like OS details, expected behaviour, etc.

Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

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. 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 details about your configuration and environment:

  • What's the name and version of the OS you're using?

Pull Requests

The process described here has several goals:

Maintain Smart Units Converter's quality Priritize issues that are important to users Engage the community in working toward the best possible Smart Units Converter Enable a sustainable system for Smart Units Converter's maintainers to review contributions

Please follow these steps to have your contribution considered by the maintainers:

  1. Follow the styleguides
  2. After you submit your pull request, verify that all status checks are passing What if the status checks are failing? If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.

While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")

JavaScript Styleguide

All JavaScript must adhere to JavaScript Standard Style.

Documentation Styleguide

Use Markdown.

Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

Attribution

This Contribution instructions were adapted from Atom's Contributing.md

Code Style Checker and Analyzer

Standard Js

Installation npm install standard --global in comand line interface to install globally npm install standard --save-dev in command line interface to install locally

Running Standard Js go to root of project and type standard if StandardJs is installed globally go to root of project and type npx standard if StandardJs is installed locally Instead of installing it using npm, you can also use the extension available on VS Code