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

CONTRIBUTING.md for LitData #391

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

deependujha
Copy link
Collaborator

What does this PR do?

Fixes #354

I've just copy-pasted CONTRIBUTING.md from pytorch-lightning repository. No modifications done yet. Let's Work together on this and adapt it for LitData.

Aim is to make it simple and powerful enough for beginners to get started with contributing to LitData.

cc:
@bhimrazy

PR review

Anyone in the community is free to review the PR once the tests have passed.
If we didn't discuss your PR in GitHub issues there's a high chance it will not be merged.

Did you have fun?

Make sure you had fun coding 🙃

@deependujha deependujha marked this pull request as draft October 8, 2024 06:22
Copy link

codecov bot commented Oct 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78%. Comparing base (d3b11ae) to head (59ea824).

Additional details and impacted files
@@         Coverage Diff         @@
##           main   #391   +/-   ##
===================================
  Coverage    78%    78%           
===================================
  Files        34     34           
  Lines      5022   5022           
===================================
+ Hits       3925   3931    +6     
+ Misses     1097   1091    -6     

@bhimrazy
Copy link
Collaborator

bhimrazy commented Oct 8, 2024

Let's Work together on this and adapt it for LitData.

Sure @deependujha. Thanks for drafting a PR.

Test description about text reason to be
"""

class ExtendedModel(BoringModel):
Copy link
Collaborator

Choose a reason for hiding this comment

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

Worth to update the litdata related things.

CONTRIBUTING.md Outdated Show resolved Hide resolved
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.

A contributing.md for the project
3 participants