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

Added development section to the readme #44

Merged
merged 7 commits into from
Aug 29, 2024
Merged

Added development section to the readme #44

merged 7 commits into from
Aug 29, 2024

Conversation

MohamedNasser8
Copy link
Collaborator

In this PR I added the following:

  • Development Section: A new section was added to the README file to guide developers.
  • Environment Options: Provided an option for users to choose between Poetry or venv for managing dependencies.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@MohamedNasser8
Copy link
Collaborator Author

I think it's ready to be merged! @ltorres6

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@ltorres6
Copy link
Collaborator

@MohamedNasser8 Thanks Mohamed, one more iteration for the typos please. I am going to add Lucy and Sirisha to review as well with fresh eyes.

README.md Show resolved Hide resolved
Copy link
Collaborator

@LucyKershaw LucyKershaw left a comment

Choose a reason for hiding this comment

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

This looks very good, I agree with Sirisha that perhaps the dev environment setup should just be in the developer guide?

My only other comment is maybe something we can discuss. For the developer who isn't very experienced, the section on poetry and pre-commit hooks could perhaps do with a bit more information - maybe a link to a guide or a simple description about what this does?

Other than that, this looks great.

@MohamedNasser8
Copy link
Collaborator Author

I think keeping the development environment set in the README for now is important, as it informs anyone coming to the repo on how to start contributing. Once we have a published version, we can update the README accordingly and remove the development setup part. What do you think, @ltorres6 ?

@ltorres6
Copy link
Collaborator

I think a good compromise is that it should be in both. We should give people a simple overview of how to start developing in the readme for quick start users, and then point to a more detailed version in the docs for users who want/need to know more. This would maintain visibility/exposure of our guidelines from the repo, and allow us to expand in as much detail as we want/need within the docs.

@ltorres6
Copy link
Collaborator

@MohamedNasser8 Can you add some details on the pre-commit hooks?

@MohamedNasser8
Copy link
Collaborator Author

Okay, will do it

@ltorres6 ltorres6 self-requested a review August 29, 2024 14:38
Copy link
Collaborator

@ltorres6 ltorres6 left a comment

Choose a reason for hiding this comment

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

LGTM

@ltorres6 ltorres6 merged commit fb73ed2 into main Aug 29, 2024
5 checks passed
@ltorres6 ltorres6 deleted the Update-Readme branch August 29, 2024 14:40
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.

4 participants