-
Notifications
You must be signed in to change notification settings - Fork 13
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
pyg4ometry : (docs) Update the README and start CHANGE log #71
Conversation
875723a
to
e319c62
Compare
# Conflicts: # CHANGES.md # README.md
775d7ed
to
0a45467
Compare
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 |
CHANGES.md
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think CHANGELOG.md
is more widely used
|
||
## Developer notes | ||
|
||
- Building the manual |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add pip install '.[docs]'
- Building the manual | ||
- `cd pyg4ometry/docs` | ||
- `make` | ||
- Running tests |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add pip install '.[test]'
README.md
Outdated
|
||
- https://pyg4ometry.readthedocs.io/en/latest/ | ||
|
||
## Developer notes |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
854abf4
to
0698bdb
Compare
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