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 repo-level documentation #43

Merged
merged 7 commits into from
Jun 5, 2024
Merged

Update repo-level documentation #43

merged 7 commits into from
Jun 5, 2024

Conversation

kheal
Copy link
Collaborator

@kheal kheal commented May 29, 2024

Addresses #39.

Adds issue templates for bug reports and feature requests.
Adds CONTRIBUTING.md guidelines and points to repo-level code of conduct. Relocates information regarding CONTRIBUTING from general readme.
Adds PR_TEMPLATE.md

@kheal kheal requested a review from brynnz22 May 29, 2024 19:50
@kheal kheal self-assigned this May 29, 2024
@kheal kheal marked this pull request as draft May 29, 2024 19:50
@kheal kheal changed the title Update issue templates Update repo-level documentation May 29, 2024
@kheal kheal marked this pull request as ready for review May 29, 2024 21:46
Copy link
Contributor

@brynnz22 brynnz22 left a comment

Choose a reason for hiding this comment

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

This all looks really good to me! Just one suggestion of adding a bit to the Contributing.md about links to the readable versions of the notebooks.

.github/CONTRIBUTING.md Show resolved Hide resolved
.github/PULL_REQUEST_TEMPLATE.md Show resolved Hide resolved
@kheal
Copy link
Collaborator Author

kheal commented Jun 4, 2024

@brynnz22, I added information to the CONTRIBUTING.md regarding saving rendered notebooks and adding links to the associated README.

@brynnz22 brynnz22 self-requested a review June 5, 2024 15:08
@brynnz22 brynnz22 merged commit 92a46be into main Jun 5, 2024
@brynnz22 brynnz22 deleted the issue_templates branch June 5, 2024 15:09
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.

2 participants