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

Add a section in the readme for developers #1923

Merged
merged 5 commits into from
Apr 24, 2023
Merged

Add a section in the readme for developers #1923

merged 5 commits into from
Apr 24, 2023

Conversation

miguelgfierro
Copy link
Collaborator

Description

Fix #1921

Related Issues

References

Checklist:

  • I have followed the contribution guidelines and code style for this project.
  • I have added tests covering my contributions.
  • I have updated the documentation accordingly.
  • This PR is being made to staging branch and not to main branch.

SETUP.md Outdated
@@ -34,6 +34,24 @@ pip install recommenders[examples,spark]
# c. Run the notebook.
```

## Setup for developers
Copy link
Collaborator

Choose a reason for hiding this comment

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

Capitalize d in developers for consistency

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

good catch

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

it´s done

SETUP.md Outdated
@@ -34,6 +34,24 @@ pip install recommenders[examples,spark]
# c. Run the notebook.
```

## Setup for developers
Copy link
Collaborator

Choose a reason for hiding this comment

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

I wonder if it is better to move this section towards later part of the doc. Maybe right before the content related to making a release? And make this a top-level section of Setup for Developers of the Repository

@wutaomsft wutaomsft merged commit 9edd7f6 into staging Apr 24, 2023
@miguelgfierro miguelgfierro deleted the readme_dev branch April 25, 2023 13:14
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.

None yet

2 participants