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

improve developers docs #130

Merged
merged 20 commits into from
Dec 17, 2022
Merged

improve developers docs #130

merged 20 commits into from
Dec 17, 2022

Conversation

giovp
Copy link
Member

@giovp giovp commented Dec 9, 2022

this PR does:

  • splits the developers_docs.md in:
    • developers_docs.md titled Using this template which explains how to go from running cruft ... to making having a functional github repository.
    • contributing.md titled Contributing guide which explains how to contribute to the repository (from docs building to publishing)
  • extend instructions on codecov and add example on manually publishing a python package

this PR does not:

  • add high level tutorials on python packaging (to be done in separate PR).
  • documentation on github actions (to be done in separate PR).
  • adding the automated publishing discussed in Add action for publish/upload on PyPI #88

actually close #119

@github-actions
Copy link

github-actions bot commented Dec 9, 2022

A PR has been generated to the instance repo:
scverse/cookiecutter-scverse-instance#33

You can check out the PR to preview your changes
in an instance of the cookiecutter template. The PR will be kept in sync with
this PR automatically.

@giovp giovp requested review from ivirshup and grst December 9, 2022 14:48
Copy link
Collaborator

@grst grst left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Member

@ivirshup ivirshup left a comment

Choose a reason for hiding this comment

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

Looks good. A few minor comments, I may also just fix these myself once I'm off the train and back to wifi

{{cookiecutter.project_name}}/docs/contributing.md Outdated Show resolved Hide resolved
{{cookiecutter.project_name}}/docs/developer_docs.md Outdated Show resolved Hide resolved
@ivirshup
Copy link
Member

I think we also discussed changing the name of the developer docs, since the contributing guide is also developer docs.

Maybe something like: "managing this repository"?

@giovp giovp merged commit 0d42e42 into main Dec 17, 2022
@giovp giovp deleted the feature/developers-docs branch December 17, 2022 09:21
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.

Pytest doesn't find project's module
3 participants