Skip to content
This repository has been archived by the owner on Dec 15, 2022. It is now read-only.

Latest commit

 

History

History
39 lines (23 loc) · 2.39 KB

CONTRIBUTING.md

File metadata and controls

39 lines (23 loc) · 2.39 KB

Contributing to github-telemetry

👍 🎉 💖 Thanks for your interest! 💖 🎉 👍

+Contributions to this project are released to the public under the project's open source license.

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

Code of Conduct

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

What should I know before I get started?

telemetry is hosted in the Atom org, but the intention is that it could be used by other GitHub tools. This is why it's a npm module and not simply an Atom package.

That said, Atom is the first user of telemetry. If you are looking to contribute to where telemetry is called from Atom, please see the Atom contributing guide.

How Can I Contribute?

Reporting Bugs

Before creating bug reports, please check existing issues 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. 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.

Submitting a pull request

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

  • Write tests.
  • Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
  • Write a good commit message.

Resources