Skip to content

Latest commit

 

History

History
57 lines (40 loc) · 3.82 KB

CONTRIBUTING.md

File metadata and controls

57 lines (40 loc) · 3.82 KB
Raw

Contributing to Atom

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

How Can I Contribute?

Reporting Bugs

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

Before creating bug reports, please make sure it has not been submmited already in the issues section as you might find out that you don't need to create one.

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?

Explain the problem and include additional details to help the maintainer(s) 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 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.

Provide more context by answering these questions:

  • Did the problem start happening recently (e.g. after updating to a new version of Rim) or was this always a problem?
  • If the problem started happening recently, can you reproduce the problem in an older version of Rim? What's the most recent version in which the problem doesn't happen? You can download older versions of Atom from the releases page.
  • Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.

Include details about your configuration and environment:

  • What's the name and version of the OS you're using?
  • Are you running Rim in a virtual machine? If so, which VM software are you using and which operating systems and versions are used for the host and the guest?
  • Are you using Rim with multiple monitors? If so, can you reproduce the problem when you use a single monitor?
  • Which keyboard layout are you using? Are you using a US layout or some other layout?

Pull Requests

The process described here has several goals:

  • Maintain quality
  • Fix problems that are important to users
  • Engage the community in working toward the best possible Rim
  • Enable a sustainable system for the Rim maintainer(s) to review contributions

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
  • When only changing documentation, include [ci skip] in the commit title
  • Consider using emojis in the commit message that makes sense to use in terms of context

Additional Notes

Currently None