Skip to content

Commit 8461d0e

Browse files
committed
clean: Apply lint, format and toc generation
1 parent 4cb4dcd commit 8461d0e

15 files changed

+353
-382
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+9-18
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,22 @@
11
---
2-
name: Bug report
3-
about: Create a report to help us improve
4-
title: ''
5-
labels: ''
6-
assignees: ''
72

8-
---
3+
name: Bug report about: Create a report to help us improve title: '' labels: '' assignees: '' ---**Describe the bug** A
4+
clear and concise description of what the bug is.
95

10-
**Describe the bug**
11-
A clear and concise description of what the bug is.
6+
**To Reproduce** Steps to reproduce the behavior:
127

13-
**To Reproduce**
14-
Steps to reproduce the behavior:
158
1. Go to '...'
169
2. Click on '....'
1710
3. Scroll down to '....'
1811
4. See error
1912

20-
**Expected behavior**
21-
A clear and concise description of what you expected to happen.
13+
**Expected behavior** A clear and concise description of what you expected to happen.
2214

23-
**Screenshots**
24-
If applicable, add screenshots to help explain your problem.
15+
**Screenshots** If applicable, add screenshots to help explain your problem.
2516

2617
**Desktop (please complete the following information):**
27-
- OS: [e.g. Windows, Linux, Mac]
28-
- Version [e.g. 22]
2918

30-
**Additional context**
31-
Add any other context about the problem here.
19+
- OS: [e.g. Windows, Linux, Mac]
20+
- Version [e.g. 22]
21+
22+
**Additional context** Add any other context about the problem here.
+7-15
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,12 @@
11
---
2-
name: Feature request
3-
about: Suggest an idea for this project
4-
title: ''
5-
labels: ''
6-
assignees: ''
72

8-
---
9-
10-
**Is your feature request related to a problem? Please describe.**
11-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
3+
name: Feature request about: Suggest an idea for this project title: '' labels: '' assignees: '' ---**Is your feature
4+
request related to a problem? Please describe.** A clear and concise description of what the problem is. Ex. I'm always
5+
frustrated when [...]
126

13-
**Describe the solution you'd like**
14-
A clear and concise description of what you want to happen.
7+
**Describe the solution you'd like** A clear and concise description of what you want to happen.
158

16-
**Describe alternatives you've considered**
17-
A clear and concise description of any alternative solutions or features you've considered.
9+
**Describe alternatives you've considered** A clear and concise description of any alternative solutions or features
10+
you've considered.
1811

19-
**Additional context**
20-
Add any other context or screenshots about the feature request here.
12+
**Additional context** Add any other context or screenshots about the feature request here.

CODE_OF_CONDUCT.md

+33-48
Original file line numberDiff line numberDiff line change
@@ -2,75 +2,60 @@
22

33
## Our Pledge
44

5-
In the interest of fostering an open and welcoming environment, we as
6-
contributors and maintainers pledge to making participation in our project and
7-
our community a harassment-free experience for everyone, regardless of age, body
8-
size, disability, ethnicity, sex characteristics, gender identity and expression,
9-
level of experience, education, socio-economic status, nationality, personal
10-
appearance, race, religion, or sexual identity and orientation.
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making
6+
participation in our project and our community a harassment-free experience for everyone, regardless of age, body size,
7+
disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education,
8+
socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
119

1210
## Our Standards
1311

14-
Examples of behavior that contributes to creating a positive environment
15-
include:
12+
Examples of behavior that contributes to creating a positive environment include:
1613

17-
* Using welcoming and inclusive language
18-
* Being respectful of differing viewpoints and experiences
19-
* Gracefully accepting constructive criticism
20-
* Focusing on what is best for the community
21-
* Showing empathy towards other community members
14+
- Using welcoming and inclusive language
15+
- Being respectful of differing viewpoints and experiences
16+
- Gracefully accepting constructive criticism
17+
- Focusing on what is best for the community
18+
- Showing empathy towards other community members
2219

2320
Examples of unacceptable behavior by participants include:
2421

25-
* The use of sexualized language or imagery and unwelcome sexual attention or
26-
advances
27-
* Trolling, insulting/derogatory comments, and personal or political attacks
28-
* Public or private harassment
29-
* Publishing others' private information, such as a physical or electronic
30-
address, without explicit permission
31-
* Other conduct which could reasonably be considered inappropriate in a
32-
professional setting
22+
- The use of sexualized language or imagery and unwelcome sexual attention or advances
23+
- Trolling, insulting/derogatory comments, and personal or political attacks
24+
- Public or private harassment
25+
- Publishing others' private information, such as a physical or electronic address, without explicit permission
26+
- Other conduct which could reasonably be considered inappropriate in a professional setting
3327

3428
## Our Responsibilities
3529

36-
Project maintainers are responsible for clarifying the standards of acceptable
37-
behavior and are expected to take appropriate and fair corrective action in
38-
response to any instances of unacceptable behavior.
30+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take
31+
appropriate and fair corrective action in response to any instances of unacceptable behavior.
3932

40-
Project maintainers have the right and responsibility to remove, edit, or
41-
reject comments, commits, code, wiki edits, issues, and other contributions
42-
that are not aligned to this Code of Conduct, or to ban temporarily or
43-
permanently any contributor for other behaviors that they deem inappropriate,
44-
threatening, offensive, or harmful.
33+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits,
34+
issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any
35+
contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
4536

4637
## Scope
4738

48-
This Code of Conduct applies both within project spaces and in public spaces
49-
when an individual is representing the project or its community. Examples of
50-
representing a project or community include using an official project e-mail
51-
address, posting via an official social media account, or acting as an appointed
52-
representative at an online or offline event. Representation of a project may be
53-
further defined and clarified by project maintainers.
39+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the
40+
project or its community. Examples of representing a project or community include using an official project e-mail
41+
address, posting via an official social media account, or acting as an appointed representative at an online or offline
42+
event. Representation of a project may be further defined and clarified by project maintainers.
5443

5544
## Enforcement
5645

57-
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58-
reported by contacting the project team at rtfrodrigo [at] gmail [dot] com. All
59-
complaints will be reviewed and investigated and will result in a response that
60-
is deemed necessary and appropriate to the circumstances. The project team is
61-
obligated to maintain confidentiality with regard to the reporter of an incident.
62-
Further details of specific enforcement policies may be posted separately.
46+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at
47+
rtfrodrigo [at] gmail [dot] com. All complaints will be reviewed and investigated and will result in a response that is
48+
deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with
49+
regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
6350

64-
Project maintainers who do not follow or enforce the Code of Conduct in good
65-
faith may face temporary or permanent repercussions as determined by other
66-
members of the project's leadership.
51+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent
52+
repercussions as determined by other members of the project's leadership.
6753

6854
## Attribution
6955

70-
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71-
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
56+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at
57+
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
7258

7359
[homepage]: https://www.contributor-covenant.org
7460

75-
For answers to common questions about this code of conduct, see
76-
https://www.contributor-covenant.org/faq
61+
For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq

CONTRIBUTING.md

+23-24
Original file line numberDiff line numberDiff line change
@@ -2,29 +2,31 @@
22

33
### Main rules
44

5-
* Before you open a ticket or send a pull request, [search](https://github.com/rtfpessoa/diff2html-cli/issues) for previous discussions about the same feature or issue. Add to the earlier ticket if you find one.
5+
- Before you open a ticket or send a pull request, [search](https://github.com/rtfpessoa/diff2html-cli/issues) for
6+
previous discussions about the same feature or issue. Add to the earlier ticket if you find one.
67

7-
* If you're proposing a new feature, make sure you create an issue to let other contributors know what you are working on.
8+
- If you're proposing a new feature, make sure you create an issue to let other contributors know what you are working
9+
on.
810

9-
* Before sending a pull request make sure your code is tested.
11+
- Before sending a pull request make sure your code is tested.
1012

11-
* Before sending a pull request for a feature, be sure to run tests with `npm test`.
13+
- Before sending a pull request for a feature, be sure to run tests with `npm test`.
1214

13-
* Use the same coding style as the rest of the codebase, most of the check can be performed with `npm run style`.
15+
- Use the same coding style as the rest of the codebase, most of the check can be performed with `npm run style`.
1416

15-
* Use `git rebase` (not `git merge`) to sync your work from time to time with the master branch.
17+
- Use `git rebase` (not `git merge`) to sync your work from time to time with the master branch.
1618

17-
* After creating your pull request make sure the build is passing on [CircleCI](https://circleci.com/gh/rtfpessoa/diff2html-cli)
18-
and that [Codacy](https://www.codacy.com/app/Codacy/diff2html-cli) is also confident in the code quality.
19+
- After creating your pull request make sure the build is passing on
20+
[CircleCI](https://circleci.com/gh/rtfpessoa/diff2html-cli) and that
21+
[Codacy](https://www.codacy.com/app/Codacy/diff2html-cli) is also confident in the code quality.
1922

2023
### Commit Style
2124

22-
Writing good commit logs is important. A commit log should describe what changed and why.
23-
Follow these guidelines when writing one:
25+
Writing good commit logs is important. A commit log should describe what changed and why. Follow these guidelines when
26+
writing one:
2427

25-
1. The first line should be 50 characters or less and contain a short
26-
description of the change prefixed with the name of the changed
27-
subsystem (e.g. "net: add localAddress and localPort to Socket").
28+
1. The first line should be 50 characters or less and contain a short description of the change prefixed with the name
29+
of the changed subsystem (e.g. "net: add localAddress and localPort to Socket").
2830
2. Keep the second line blank.
2931
3. Wrap all other lines at 72 columns.
3032

@@ -47,14 +49,11 @@ nicely even when it is indented.
4749

4850
By making a contribution to this project, I certify that:
4951

50-
* (a) The contribution was created in whole or in part by me and I
51-
have the right to submit it under the open source license indicated
52-
in the file; or
53-
* (b) The contribution is based upon previous work that, to the best
54-
of my knowledge, is covered under an appropriate open source license
55-
and I have the right under that license to submit that work with
56-
modifications, whether created in whole or in part by me, under the
57-
same open source license (unless I am permitted to submit under a
58-
different license), as indicated in the file; or
59-
* (c) The contribution was provided directly to me by some other
60-
person who certified (a), (b) or (c) and I have not modified it.
52+
- (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source
53+
license indicated in the file; or
54+
- (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate
55+
open source license and I have the right under that license to submit that work with modifications, whether created in
56+
whole or in part by me, under the same open source license (unless I am permitted to submit under a different
57+
license), as indicated in the file; or
58+
- (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not
59+
modified it.

0 commit comments

Comments
 (0)