colorls/CONTRIBUTING.md

Contribution guidelines

First of all, thanks for thinking of contributing to this project. 😄

Before sending a Pull Request, please make sure that you're assigned the task on a GitHub issue.

• If a relevant issue already exists, discuss on the issue and get it assigned to yourself on GitHub.
• If no relevant issue exists, open a new issue and get it assigned to yourself on GitHub.

Please proceed with a Pull Request only after you're assigned. It'd be sad if your Pull Request (and your hardwork) isn't accepted just because it isn't idealogically compatible.

Developing the gem

1. Install with

git clone 
cd colorls
gem install bundler
bundle install

2. Make your changes in a different git branch. These changes can be

• add better icons to YAML files
• add more flag options to the ruby gem.

3. (Optional) To test whether lc is working properly, do

rake install
lc # start using lc

4. (Required for YAML file changes) These are the specifications for the YAML files -

• files.yaml, folders.yaml : The keys are sorted alphabetically.
• file_aliases.yaml, folder_aliases.yaml : The values are sorted alphabetically. For each set of keys mapping to a value, those set of keys are also sorted alphabetically.

5. Check before pushing

bundle exec rubocop
bundle exec rspec