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

Latest commit

 

History

History
60 lines (46 loc) · 2.32 KB

CONTRIBUTING.md

File metadata and controls

60 lines (46 loc) · 2.32 KB
Raw

Contributing

Do One Thing and Do It Well

Style Guide

Syntax

  • Use EditorConfig to define and maintain consistent coding styles.
  • Use 2 spaces indentation.
  • Use UTF-8 encoding without BOM.
  • Use Unix-style line endings (LF).
  • End files with a newline.
  • Remove any trailing whitespace characters except in Markdown files where a line-break must be forced.
  • Keep line length less than 120 characters, preferably less than 80 characters.
  • When in doubt, follow the conventions you see used in the source already.

Git Commit Messages

  • Use the present tense. (“Add feature” not “Added feature”.)
  • Use the imperative mood. (“Move cursor to...” not “Moves cursor to...”.)
  • Capitalize the summary line (first line).
  • Do not end the summary line with a period.
  • Limit the summary line to 50 characters or less.
  • Always leave the second line blank.
  • Wrap the description at 72 characters.
  • Reference issues and pull requests liberally.

Issue Reporting Guidelines

  • Bugs and enhancement suggestions are tracked as GitHub issues.
  • Try to search for your issue before submitting it. It may have already been answered or fixed.
  • Check if the issue is reproducible with the last stable version.
  • Use a clear and descriptive title for the issue.
  • When reporting a bug, describe the exact steps which reproduce the problem.
  • Include screenshots whenever possible.
  • Include your environment like Atom version and OS version.

Pull Request Guidelines

  • Create a topic branch from master.
  • Squash the commit if there are too many small ones.
  • Make sure apm --test passes. (See Development Setup.)
  • If adding a new feature, provide convincing reasons to add this feature.
  • If fixing a bug, provide a detailed description in the PR.

Development Setup

# Fork and clone this repository.
$ git clone https://github.com/<username>/atom-fonts-cjk.git
$ cd atom-fonts-cjk

# Install required npm packages.
$ npm install

# Run npm test script to make sure everything works fine.
$ npm run test

For more information about Atom package specs, see Hacking Atom: Writing specs section in the Atom Flight Manual.