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: update the doc of makefile target with lint_perltidy #8883

Merged
merged 8 commits into from
Aug 30, 2023

Conversation

albatrousse
Copy link
Contributor

just casually adding a line with an explanation of the command make lint_perltidy and solution to a common issue with the latter command

@albatrousse albatrousse requested a review from a team as a code owner August 18, 2023 12:59
@github-actions github-actions bot added the 🐋 Docker https://docker-curriculum.com/ label Aug 18, 2023
@albatrousse albatrousse changed the title doc: update the doc of makefile target with lint_perltidy docs: update the doc of makefile target with lint_perltidy Aug 18, 2023
@albatrousse albatrousse added 📚 Documentation Documentation issues improve the project for everyone. Makefile and removed 🐋 Docker https://docker-curriculum.com/ labels Aug 18, 2023
docker/README.md Outdated
@@ -35,4 +35,9 @@ See also [targets to run tests](../docs/dev/how-to-write-and-run-tests.md#runnin
| `make clean` | Clean up your dev environment: removes locally bound folders, run `hdown` and `prune`. | Run `make dev` to recreate a fresh dev env afterwards. |
| `make import_sample_data` | Load sample data (~100 products) into the MongoDB database. | |
| `make import_prod_data` | Load latest prod data (~2M products, 1.7GB) into the MongoDB database. | Takes up to 10m. Not recommended for dev setups ! |
| `make lint_perltidy` | Indent and reformat your code |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe just "make lint" ? Easier to remember/type, and make lint is running make lint_perltidy

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, it is a good idea. I'll do this right now

@github-actions github-actions bot added 🐋 Docker https://docker-curriculum.com/ and removed 📚 Documentation Documentation issues improve the project for everyone. labels Aug 21, 2023
@codecov-commenter
Copy link

codecov-commenter commented Aug 21, 2023

Codecov Report

Merging #8883 (f7eb7ee) into main (d3304c1) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #8883   +/-   ##
=======================================
  Coverage   45.54%   45.54%           
=======================================
  Files          64       64           
  Lines       19519    19519           
  Branches     4738     4738           
=======================================
  Hits         8889     8889           
  Misses       9454     9454           
  Partials     1176     1176           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Makefile Outdated Show resolved Hide resolved
docker/README.md Outdated Show resolved Hide resolved
@sonarcloud
Copy link

sonarcloud bot commented Aug 25, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@alexgarel alexgarel merged commit c4d0a00 into main Aug 30, 2023
13 checks passed
@alexgarel alexgarel deleted the albatrousse_perltidy_doc branch August 30, 2023 12:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🐋 Docker https://docker-curriculum.com/ Makefile
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants