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

pyg4ometry : (docs) Update the README and start CHANGE log #71

Merged
merged 5 commits into from
Aug 4, 2023

Conversation

stewartboogert
Copy link
Member

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

# Conflicts:
#	CHANGES.md
#	README.md
@stewartboogert stewartboogert force-pushed the readmeAndChange branch 2 times, most recently from 943e142 to 5e0c06c Compare August 2, 2023 19:24
@codecov
Copy link

codecov bot commented Aug 2, 2023

Codecov Report

Merging #71 (0698bdb) into main (ed671d7) will not change coverage.
Report is 3 commits behind head on main.
The diff coverage is n/a.

@@           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

@gipert
Copy link
Member

gipert commented Aug 3, 2023

Let's discuss this on the phone, I have a proposal

CHANGES.md Outdated
Copy link
Member

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
Copy link
Member

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
Copy link
Member

@gipert gipert Aug 4, 2023

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
Copy link
Member

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
@stewartboogert stewartboogert merged commit 0468fca into g4edge:main Aug 4, 2023
11 checks passed
@stewartboogert stewartboogert deleted the readmeAndChange branch August 17, 2023 14:54
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.

2 participants