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

Update local development setup instructions in CONTRIBUTING.md and template #204

Conversation

Naman-Priyadarshi
Copy link
Contributor

@Naman-Priyadarshi Naman-Priyadarshi commented Feb 7, 2024

Pull Request description

This pull request updates the CONTRIBUTING file for scicookie and the template to provide accurate and up-to-date instructions for setting up the project locally. The previous instructions were outdated and misleading, as they referenced a setup.py file that does not exist in the repository.

Changes Made:

Updated the CONTRIBUTING.md with clear and concise instructions for local development setup.
Removed references to the nonexistent setup.py file.
Provided alternative installation methods such as Poetry (poetry install) and pip (pip install -e .).
Replaced $ with Code Blocks
Fixed Issue in template where instructions said tox and flake8 but referenced make lint and make tests

Fixes #203

How to test these changes

  • ...

Pull Request checklists

This PR is a:

  • bug-fix
  • new feature
  • maintenance

About this PR:

  • it includes tests.
  • the tests are executed on CI.
  • the tests generate log file(s) (path).
  • pre-commit hooks were executed locally.
  • this PR requires a project documentation update.

Author's checklist:

  • I have reviewed the changes and it contains no misspelling.
  • The code is well commented, especially in the parts that contain more complexity.
  • New and old tests passed locally.

Additional information

Reviewer's checklist

Copy and paste this template for your review's note:

## Reviewer's Checklist

- [ ] I managed to reproduce the problem locally from the `main` branch
- [ ] I managed to test the new changes locally
- [ ] I confirm that the issues mentioned were fixed/resolved

Copy link
Member

@Saransh-cpp Saransh-cpp left a comment

Choose a reason for hiding this comment

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

Thanks for taking this up, @Naman-Priyadarshi! A few comments below -

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
docs/contributing.md Show resolved Hide resolved
Naman Priyadarshi added 2 commits February 8, 2024 16:25
@Naman-Priyadarshi
Copy link
Contributor Author

Naman-Priyadarshi commented Feb 8, 2024

I have resolved the changes. Also, I replaced the flake8 and tox step with adding a pre-commit section. Let me know how it looks!

CONTRIBUTING.md Show resolved Hide resolved
docs/contributing.md Show resolved Hide resolved
Copy link
Member

@Saransh-cpp Saransh-cpp 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, thanks @Naman-Priyadarshi!

@Saransh-cpp Saransh-cpp merged commit 2b46e93 into osl-incubator:main Feb 8, 2024
11 checks passed
@Naman-Priyadarshi Naman-Priyadarshi deleted the update-local-dev-instructions branch February 20, 2024 14:33
Copy link

🎉 This PR is included in version 0.7.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Incorrect Setup Instructions in CONTRIBUTING for Local Development
2 participants