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

docs: Add development installation instructions #246

Merged
merged 8 commits into from
Mar 18, 2024

Conversation

KennethEnevoldsen
Copy link
Contributor

Added missing development installation instructions.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
I don't believe this is nec. with the setup.py specifying the same dependencies
This ensure that the user runs exactly what the CI expects
@KennethEnevoldsen
Copy link
Contributor Author

KennethEnevoldsen commented Mar 15, 2024

I have now addtionally:

  1. updated the CI to use the make commands (this allows the user a 1-1 mapping between ci and make commands)
  2. Added linting to docs
  3. removed requirements.txt (as I don't believe it is needed)

Copy link
Contributor

@Muennighoff Muennighoff left a comment

Choose a reason for hiding this comment

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

Really nice work; should make contributing much easier!

Makefile Show resolved Hide resolved
README.md Show resolved Hide resolved
@Muennighoff
Copy link
Contributor

Are the failing tests expected?

@KennethEnevoldsen
Copy link
Contributor Author

Are the failing tests expected?

No. Not sure why it happens. Will try to debug it

Makefile Outdated
pytest -s -v
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
pytest -s -v
pytest

.github/workflows/python-package.yml Show resolved Hide resolved
@KennethEnevoldsen KennethEnevoldsen merged commit 0048878 into main Mar 18, 2024
3 checks passed
@KennethEnevoldsen KennethEnevoldsen deleted the add-dev-install branch March 18, 2024 08:26
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.

3 participants