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.

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

docs: add list of all practices to README.md #199

Merged
merged 29 commits into from
Jan 28, 2020

Conversation

adelkahomolova
Copy link
Contributor

Add list of practices in README.md and allow user to use subcommand to list all practices in CLI.

@adelkahomolova adelkahomolova self-assigned this Jan 9, 2020
@prokopsimek
Copy link
Member

prokopsimek commented Jan 9, 2020

DX Scanner Report DXScanner.io

https://github.com/DXHeroes/dx-scanner

⚠️ Improvements with medium impact

Break down large pull requests into smaller ones

Large pull request are hard to code review and it reduces the probability of finding bugs. Split your PRs into logical units. Do not have PR with more than 1000 changes. https://medium.com/@hugooodias/the-anatomy-of-a-perfect-pull-request-567382bb6067

Solve Issues Continuously

Do not have an open Issues more than 60 days. Solve Issues continuously. https://hackernoon.com/45-github-issues-dos-and-donts-dfec9ab4b612

Update Dependencies of Minor and Patch Level

Keep the dependencies updated to eliminate security concerns and compatibility issues. Use, for example, npm-check-updates. https://github.com/tjunnone/npm-check-updates

Name New Current
@types/eslint 6.1.7 6.1.3
@types/js-yaml 3.12.2 3.12.1
axios 0.19.2 0.19.1
codecov 3.6.2 3.6.1
rimraf 3.0.1 3.0.0
@octokit/rest 16.39.0 16.37.0
simple-git 1.131.0 1.130.0
@types/node 13.5.0 12.12.25
@typescript-eslint/eslint-plugin 2.18.0 2.16.0
@typescript-eslint/parser 2.18.0 2.16.0

Impact changed from high to medium.

🔔 Improvements with minor impact

Write Commit Messages by Convention

https://www.conventionalcommits.org/

Commit Message Problems
Add fixFlag test subject may not be empty; type may not be empty
Fix fixPattern regex subject may not be empty; type may not be empty
Add options to readme subject may not be empty; type may not be empty
Add fixPattern flag subject may not be empty; type may not be empty
Update Dependencies of Major Level

Keep the dependencies updated to have all possible features. Use, for example, npm-check-updates. https://github.com/tjunnone/npm-check-updates

Name New Current
@semantic-release/changelog 5.0.0 3.0.6
@semantic-release/git 9.0.0 8.0.0
@types/jest 25.1.0 24.9.0
@types/node 13.5.0 12.12.25
@types/semver 7.1.0 6.2.0
semantic-release 17.0.0 16.0.2
Use a JS Logging Library

Use a logging library to avoid errors and even cyber attacks. The most widely used logging library in the JavaScript community is Winston. https://www.npmjs.com/package/winston/


Implementation is not adoption.
We can help you with both. :-)
dxheroes.io

Found a bug? Please report.

@codecov-io
Copy link

codecov-io commented Jan 19, 2020

Codecov Report

❗ No coverage uploaded for pull request base (master@19e8bd1). Click here to learn what that means.
The diff coverage is 84%.

@@            Coverage Diff            @@
##             master     #199   +/-   ##
=========================================
  Coverage          ?   87.15%           
=========================================
  Files             ?      165           
  Lines             ?     3604           
  Branches          ?      574           
=========================================
  Hits              ?     3141           
  Misses            ?      463           
  Partials          ?        0
Impacted Files Coverage Δ
src/services/git/IVCSService.ts 100% <ø> (ø)
src/inspectors/CollaborationInspector.ts 100% <ø> (ø)
src/inspectors/IIssueTrackingInspector.ts 100% <ø> (ø)
...s/LanguageIndependent/TimeToSolveIssuesPractice.ts 100% <100%> (ø)
...factories/responses/bitbucket/prResponseFactory.ts 100% <100%> (ø)
src/scanner/ScannerUtils.ts 100% <100%> (ø)
src/test/helpers/bitbucketNock.ts 100% <100%> (ø)
src/inspectors/IssueTrackingInspector.ts 100% <100%> (ø)
src/services/git/GitHubService.ts 84.66% <100%> (ø)
...ractices/JavaScript/ESLintWithoutErrorsPractice.ts 75.6% <100%> (ø)
... and 4 more

src/commands/practices.ts Outdated Show resolved Hide resolved
src/commands/run.ts Outdated Show resolved Hide resolved
src/commands/run.ts Outdated Show resolved Hide resolved
src/commands/run.ts Outdated Show resolved Hide resolved
src/scanner/Scanner.ts Outdated Show resolved Hide resolved
src/scanner/ArgumentsProvider.ts Outdated Show resolved Hide resolved
src/scanner/Scanner.ts Outdated Show resolved Hide resolved
src/commands/practices.ts Outdated Show resolved Hide resolved
@adelkahomolova adelkahomolova marked this pull request as ready for review January 22, 2020 14:22
@prokopsimek prokopsimek force-pushed the feature/list-practices branch from d10571c to dd50436 Compare January 28, 2020 08:44
- small cleanup

BREAKING CHANGE: now exists commands such as init, practices and run
# Conflicts:
#	README.md
#	src/index.ts
@prokopsimek prokopsimek force-pushed the feature/list-practices branch from 5ed7a54 to d0bfc1c Compare January 28, 2020 09:16
# [2.0.0-pre-list-practices.1](v1.38.0...v2.0.0-pre-list-practices.1) (2020-01-28)

### Bug Fixes

* allow fail and recursive to be optional ([457eb72](457eb72))
* inform user if the config file already exists ([569725a](569725a))
* parse flags with init subcommand ([3ede8e0](3ede8e0))
* remove comments a comment ideas ([e604238](e604238))
* remove unnecessary code ([bb88dd4](bb88dd4))
* remove unused commented code and import reflect-metadata ([5ad591a](5ad591a))
* remove unused flag, aliases and set new examples ([cccdf57](cccdf57))
* rename method ([d8a88cf](d8a88cf))
* rename subcommand ([e939b9e](e939b9e))
* revert change ([b4b6497](b4b6497))
* set arguments back to be required ([dc8edd6](dc8edd6))
* typo ([19e8bd1](19e8bd1))

### Features

* **core:** CLI changed to multi-command ([cbf03b0](cbf03b0))
* add two subcommands ([9661d6b](9661d6b))
* convert init flag to subcommand ([9594d3a](9594d3a))
* implement method to get practices ([871f7f2](871f7f2))
* list practices in a table ([9d8a8f6](9d8a8f6))
* wip - add subcommand ([6c33fc4](6c33fc4))

### BREAKING CHANGES

* **core:** now exists commands such as init, practices and run
@prokopsimek prokopsimek merged commit 7195dd4 into master Jan 28, 2020
@prokopsimek prokopsimek deleted the feature/list-practices branch January 28, 2020 09:53
@prokopsimek
Copy link
Member

🎉 This PR is included in version 2.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@prokopsimek
Copy link
Member

🎉 This PR is included in version 2.0.0-pre-lp.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@prokopsimek
Copy link
Member

🎉 This PR is included in version 2.0.0-pre-lp-clean2.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@prokopsimek
Copy link
Member

🎉 This PR is included in version 2.0.0-pre-list-practices-works-for-ts-and-js.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

prokopsimek added a commit that referenced this pull request Jan 28, 2020
This reverts commit 7195dd4, reversing
changes made to 07eb9ea.

# Conflicts:
#	CHANGELOG.md
#	package.json
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants