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

Update CONTRIBUTING.md and add documentation improvements hints #2228

Merged
merged 1 commit into from
Jan 7, 2023

Conversation

bdovaz
Copy link
Collaborator

@bdovaz bdovaz commented Jan 7, 2023

In the CONTIBUTING.md file right now it does not record any information as to how to test and generate the documentation.

This PR helps to make the documentation better.

This post is the one that helped to improve it #2220 (comment)

@bdovaz bdovaz requested a review from nvuillam as a code owner January 7, 2023 12:17
@codecov-commenter
Copy link

Codecov Report

Merging #2228 (31f2aaa) into main (964fe7f) will increase coverage by 0.51%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #2228      +/-   ##
==========================================
+ Coverage   82.47%   82.99%   +0.51%     
==========================================
  Files         170      170              
  Lines        4469     4470       +1     
==========================================
+ Hits         3686     3710      +24     
+ Misses        783      760      -23     
Impacted Files Coverage Δ
megalinter/utils.py 82.96% <0.00%> (ø)
megalinter/linters/DotnetFormatLinter.py 100.00% <0.00%> (ø)
megalinter/Linter.py 84.69% <0.00%> (+0.02%) ⬆️
megalinter/reporters/UpdatedSourcesReporter.py 89.74% <0.00%> (+2.56%) ⬆️
...alinter/tests/test_megalinter/helpers/utilstest.py 89.01% <0.00%> (+8.05%) ⬆️

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

Copy link
Member

@nvuillam nvuillam left a comment

Choose a reason for hiding this comment

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

Great :)

@nvuillam nvuillam merged commit 0648826 into oxsecurity:main Jan 7, 2023
@bdovaz bdovaz deleted the feature/better-contribution-docs branch January 7, 2023 16:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants