Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Properly document elvis.config #380

Closed
elbrujohalcon opened this issue Jun 8, 2016 · 6 comments
Closed

Properly document elvis.config #380

elbrujohalcon opened this issue Jun 8, 2016 · 6 comments
Assignees
@igaray
Labels
hacktoberfest
Milestone
0.5.0

Comments

@elbrujohalcon
Copy link
Member

Add samples and proper descriptions explaining what you can do and how to do it with that file.
@JohanVikman
Copy link
Contributor

Where do you want this? In the README.md?

@elbrujohalcon
Copy link
Member Author

Hi @JohanVikman !
README.md would be great but, if it's too limited, maybe you can write a wiki page and link to it from the README.md file.

@elbrujohalcon
Copy link
Member Author

As a matter of fact, the wiki (from this repo and elvis_core as well) is in desperate need for some clean-up/update.

JohanVikman added a commit to JohanVikman/elvis that referenced this issue Oct 25, 2017
@JohanVikman
[inaka#380] Add rules.config descriptions to README.md
7c9bf8c 
Added rules descriptions and examples that can be used in the rules.config.
@JohanVikman
Copy link
Contributor

Please take a look at my pr @elbrujohalcon . Is it ok?

@elbrujohalcon elbrujohalcon mentioned this issue Oct 26, 2017
Closed
JohanVikman added a commit to JohanVikman/elvis that referenced this issue Oct 26, 2017
@JohanVikman
[inaka#380] Add a section describing elvis.config
1b5daf0
elbrujohalcon added a commit that referenced this issue May 5, 2018
@elbrujohalcon
Merge pull request #477 from JohanVikman/jowi.380.document_rules
0898f50 
[#380] Add a section describing elvis.config
@elbrujohalcon elbrujohalcon mentioned this issue May 5, 2018
Closed
@igaray igaray self-assigned this Jan 2, 2019
@igaray igaray added this to the 0.4.0 milestone Jan 2, 2019
@jfacorro jfacorro mentioned this issue Feb 28, 2020
Merged
@paulo-ferraz-oliveira
Copy link
Collaborator

I believe this might be related to #438, but this issue, itself, is already dealt with (though still open), right?

@elbrujohalcon
Copy link
Member Author

Yeah. I'm closing it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@igaray igaray

Labels
hacktoberfest
Projects
None yet
Milestone
0.5.0
Development

No branches or pull requests
4 participants
@elbrujohalcon @igaray @JohanVikman @paulo-ferraz-oliveira