mirror of
https://github.com/athityakumar/colorls.git
synced 2024-09-19 05:31:23 +02:00
277f03ecaf
`rake install` just creates a new gem but does not install it and without actually installing the gem one can't test the latest release. Thus it is essential to install it first and then try it out.
1.6 KiB
1.6 KiB
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
-
Install with
git clone https://github.com/athityakumar/colorls cd colorls gem install bundler bundle install
-
Make your changes in a different git branch (say,
add-new-flag
). These changes can be- adding better icons to YAML files
- adding more flag options to the ruby gem.
-
(Optional) To test whether
colorls
executable is working properly, dorake install
Then install the gem file in the folder
pkg
. After that to use the new binary,colorls # start using colorls
-
(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.
-
Check before pushing
bundle exec rubocop bundle exec rspec
-
(Required for new flags) Add command to
.travis.yml
file.