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

Implement Phase 1 maintenance on the repo's root directory #79

Merged
merged 10 commits into from
Dec 20, 2023

Conversation

willingc
Copy link
Collaborator

Addresses #78 phase 1.

This PR:

  • edits README.md by adding commonly used sections, adding badges, and moving usage directions to a new CONTRIBUTING.md file
  • adds a CONTRIBUTING.md file seeded with the usage instructions that are currently in the README
  • add a CODE_OF_CONDUCT.md file
  • adds a minimal CHANGELOG.md file
  • adds a LICENSE file and remove src/LICENSE.txt
  • remove src/README.md

@willingc
Copy link
Collaborator Author

Will appease codacy style next week.

@@ -0,0 +1,4 @@
# Code of Conduct

Everyone interacting in the pyOpenSci project's codebases, issue trackers, chat rooms, and communication venues is
Copy link
Member

Choose a reason for hiding this comment

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

I've been meaning to add an organization wide COC in our .github repo -- I just made an asana task for this as it doesn't belong to a single repo rather to the organization

2. Update the pyOpenSci website's package listing with the package's DOI, documentation URL.
3. Update the package's stats including stars, contributors, etc. using the GitHub API

## process\_reviews.py script
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
## process\_reviews.py script
## process_reviews.py script


This repo contains a small module and 3 CLI scripts.
[![PyPI](https://img.shields.io/pypi/v/pyosmeta.svg)](https://pypi.org/project/pyosmeta/)
Copy link
Member

Choose a reason for hiding this comment

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

@willingc should we rename the repo to be pyosmeta?

I actually forgot that i pushed this to pypi. I can also setup VCS versioning and github action based release / publish workflow . i've wanted to create that tutorial anyway so minus well do it using hatchling!

Copy link
Member

@lwasser lwasser left a comment

Choose a reason for hiding this comment

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

@willingc this is a great PR. thank you. i'll open up a PR about VCS-based versioning. i thnk it will be really good for me to add that because i do it so infrequently BUT i've had to help other people set it up. i'll create the tutorial while i'm adding that functionality to this repo (as a test to ensure things work!).

lets :shipit: :)

@lwasser
Copy link
Member

lwasser commented Dec 20, 2023

merging this - we can revisit codacy via #80

@lwasser lwasser merged commit 709686c into pyOpenSci:main Dec 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants