Skip to content

Misc README updates #9

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

Merged
merged 7 commits into from
Jun 28, 2022
Merged

Misc README updates #9

merged 7 commits into from
Jun 28, 2022

Conversation

susodapop
Copy link
Contributor

Description

  • Add CONTRIBUTING.md
  • Add contributing and licence sections to README
  • Clarify connection details examples
  • Add shields badges to README

susodapop and others added 4 commits June 27, 2022 15:41
I couldn't add supported python versions. Poetry doesn't provide the correct trove classifiers based on our current Python specification. If this is important we can add it later.
@susodapop susodapop requested review from moderakh and arikfr June 27, 2022 21:21
Copy link
Collaborator

@moderakh moderakh left a comment

Choose a reason for hiding this comment

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

LGTM.
I added two comments but they are not blocking comments. Please feel free to merge the PR. and look at those later.

CONTRIBUTING.md Outdated
#### Specific tests

```bash
poetry run pytest tests/path/to/test.py
Copy link
Collaborator

Choose a reason for hiding this comment

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

how can I run a specific test method from a test file? does poetry support that?

(non blocking comment)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good catch. I added a more specific example in 22bbd22

@susodapop susodapop merged commit b696a48 into main Jun 28, 2022
@susodapop susodapop deleted the moe-items branch June 28, 2022 14:44
saishreeeee pushed a commit that referenced this pull request Jun 4, 2025
* Add license and contributing sections to README.
* Add environment setup docs to CONTRIBUTING
* Clarify example of connection details in example
* Add badges from pypi
* Explicitly call out Python 3.7 or above is needed
saishreeeee pushed a commit that referenced this pull request Jun 4, 2025
* Add license and contributing sections to README.
* Add environment setup docs to CONTRIBUTING
* Clarify example of connection details in example
* Add badges from pypi
* Explicitly call out Python 3.7 or above is needed

Signed-off-by: Sai Shree Pradhan <[email protected]>
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