linux/colorls
0
0
Fork 0
mirror of https://github.com/athityakumar/colorls.git synced 2024-09-19 05:31:23 +02:00
Code Issues Projects Releases Wiki Activity

Rectifies indent in CONTRIBUTING.md

Browse source
This commit is contained in:
Athitya Kumar 2017-07-07 17:12:59 +05:30 committed by GitHub
parent 8fd2fdb37a
commit 3cc56bf8dc
1 changed files with 19 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
CONTRIBUTING.md
View file

@ -13,32 +13,32 @@ Please proceed with a Pull Request only after you're assigned. It'd be sad if yo
1. Install with
```sh
git clone https://github.com/athityakumar/colorls
cd colorls
gem install bundler
bundle install
```
```sh
git clone https://github.com/athityakumar/colorls
cd colorls
gem install bundler
bundle install
```
2. Make your changes in a different git branch (say, `add-l-flag`). These changes can be
2. Make your changes in a different git branch (say, `add-new-flag`). These changes can be
- adding better icons to [YAML files](lib/yaml/)
- adding more flag options to the ruby gem.
- adding better icons to [YAML files](lib/yaml/)
- adding more flag options to the ruby gem.
3. (Optional) To test whether `lc` is working properly, do
```sh
rake install
lc # start using lc
```
```sh
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.
- `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
```sh
bundle exec rubocop
bundle exec rspec
```
```sh
bundle exec rubocop
bundle exec rspec
```