Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
3d7522c
commit d421ce9
Showing
3 changed files
with
68 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# Contribution guidelines | ||
|
||
First of all, thanks for thinking of contributing to this project. :smile: | ||
|
||
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 | ||
|
||
```sh | ||
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](lib/yaml/) | ||
- add more flag options to the ruby gem. | ||
|
||
|
||
3. (Optional) To test whether `lc` is working properly, do | ||
```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. | ||
|
||
5. Check before pushing | ||
|
||
```sh | ||
bundle exec rubocop | ||
bundle exec rspec | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters