CurlyBytes

Commit messages should be formatted using AngularJS conventions (one-liners are OK for now but body and footer may be required as the project matures).

Comments follow Google's style guide.

Language

The development language is English. All comments and documentation should be written in English, so that we don't end up with “franglais” methods, and so we can share our learnings with developers around the world.

However, the domain language is French. We consider each tax, collecting organism and French regulation as a domain-specific term. In the same fashion, well-known abbreviations of these domain-specific terms are accepted.

CurlyBytes

Code Comments

Bad doctors bury their mistakes; Bad architects cover them with ivy; Bad application designers write user manuals; Bad programmers write comments." So I disagree: I think that the mark of a great programmer is that I can read their code and know what's going on

There’re 2 main consumers for a written code: maintainers and external users.

Maintainers are mainly concerned with the next questions:

• What the code does
• How the code does it

CurlyBytes

User story:

As a consumer I want to contact the real estate agent so that I can visit a specific house. We can express this like a formal use-case. For example:

Use case:

• Contact real estate agent

Data:

CurlyBytes

CHANGELOG

This project is using Semantic Versioning 2.0.0

v2.0.0

New Features

• Added new fonts:
  • Noto (all variations) (#213)

CurlyBytes

Articles

• Bring Kindness Back to Open Source - by Scott Hanselman. Takeaway: "There are many folks out there with skills and knowledge that are not joining open source because their initial attempts to contributed were rebuffed." Hanselman suggests ways to welcome newcomers kindly: add an Contributing.md, tag "issues with "up-for-grabs," and make an issue noting that you will "only accept a PR from someone who has never contributed to open source" (documentation adds/fixes could be great for this).

• Documentation Driven Development - by Isaac Z. Schlueter. Takeaway: "Before anything else, write down what the thing is in README.md. I use markdown, but any portable plain-text format will do. This takes three parts: The name of the thing. The 1-sentence description of what the thing is. If necessary, a few paragraphs describing the thing. Example code demonstrating

CurlyBytes

Release Policy

Applicable from colorls v1.0.0 onwards

Versioning

Colorls follows semantic versioning whereby the version number is always in the form MAJOR.MINOR.PATCH

• Patch bump : Bug fixes
• Minor bump : New features (with backwards compatibility)

CurlyBytes

PULL_REQUEST_TEMPLATE### Description

Thanks for contributing this Pull Request. Add a brief description of what this Pull Request does. Do tag the relevant issue(s) and PR(s) below. If required, add some screenshot(s) to support your changes.

• Relevant Issues : (none)
• Relevant PRs : (none)
• Type of change :
  • New feature
  • Bug fix for existing feature
• Code quality improvement

CurlyBytes

Description

Thanks for opening this issue. Add a brief description of what this issue is, and how to recreate it. Do tag the relevant issue(s) and PR(s) below. If required, add some screenshot(s) to showcase the issue.

• Relevant Issues : (none)
• Relevant PRs : (none)
• Type of issue :
  • Installation
  • Font-related
• Feature request

CurlyBytes

emoji-cheat-sheet

This cheat sheet is automatically generated from GitHub Emoji API and Emoji Cheat Sheet.

Table of Contents

• People
• Nature

CurlyBytes

COVERAGES

A documentation of all the places on the World Wide Web, where colorls has been featured:

• YouTube : File Icons on Linux Terminal
• GitHub : Awesome README
• HackerNews : Colorls – A Ruby script that beautifies the terminal's ls command
• GitHub : A curated list of Terminal frameworks, plugins & resources for CLI lovers
• Facebook : colorls story
• openruby : colorls a ruby script that beautifies the terminals ls