chore(documentation): improvement of the documentation and the build process #113
Conversation
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
dubloom
requested review from
zacharycmontoya
and removed request for
a team
|
I also feel that scripts should not be quoted alone to launch tests, as they require upstream steps before they can be launched. I haven't modified it since it may be useful but in my opinion it could confuse users. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #113 +/- ##
==========================================
+ Coverage 69.27% 77.22% +7.94%
==========================================
Files 36 36
Lines 4000 4000
Branches 671 671
==========================================
+ Hits 2771 3089 +318
+ Misses 880 875 -5
+ Partials 349 36 -313 |
dmehala
reviewed
Sep 18, 2024
|
Converted to draft because i will need to furthermore improve the doc after openresty support |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Just by following the readme, it was almost impossible to either build something on Mac or even run the tests.
From my point of view, when arriving on a repository should be able to build/test etc... the thing without modifying anything not explicitly mentioned in the documentation
Therefore, this pull request aims to enrich the readme so that the various actions can be carried out by following only the steps within it.