pyg4ometry : (docs) Update the README and start CHANGE log #71
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
stewartboogert
force-pushed
the
readmeAndChange
branch
from
875723a
to
e319c62
Compare
# Conflicts: # CHANGES.md # README.md
stewartboogert
force-pushed
the
readmeAndChange
branch
from
775d7ed
to
0a45467
Compare
stewartboogert
force-pushed
the
readmeAndChange
branch
2 times, most recently
from
943e142
to
5e0c06c
Compare
Codecov Report
@@ Coverage Diff @@
## main #71 +/- ##
=======================================
Coverage 73.86% 73.86%
=======================================
Files 137 137
Lines 20458 20458
=======================================
Hits 15112 15112
Misses 5346 5346 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
|
Let's discuss this on the phone, I have a proposal |
gipert
reviewed
Aug 4, 2023
CHANGES.md
Outdated
There was a problem hiding this comment.
I think CHANGELOG.md is more widely used
gipert
reviewed
Aug 4, 2023
|
|
||
| ## Developer notes | ||
|
|
||
| - Building the manual |
gipert
reviewed
Aug 4, 2023
| - Building the manual | ||
| - `cd pyg4ometry/docs` | ||
| - `make` | ||
| - Running tests |
gipert
reviewed
Aug 4, 2023
README.md
Outdated
|
|
||
| - https://pyg4ometry.readthedocs.io/en/latest/ | ||
|
|
||
| ## Developer notes |
There was a problem hiding this comment.
Important to recommend running once pre-commit install.
To run pre-commit locally: pre-commit run --all-files
To run only Black: pre-commit run --all-files black
- add pre-commit instructions - add pip deps instructions for docs and test
stewartboogert
force-pushed
the
readmeAndChange
branch
from
854abf4
to
0698bdb
Compare
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.
Need a place to log changes and put useful commands in the README
I would like to avoid having make files and little fragments of code/commands dotted around the repo