Skip to content

Improve Github templates + README for contributions and support #1878

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
May 7, 2021
Merged

Improve Github templates + README for contributions and support #1878

merged 2 commits into from
May 7, 2021

Conversation

agirault
Copy link
Contributor

@agirault agirault commented Apr 26, 2021 •
edited
Loading

Context

Fix #1875

Changes

  • Updated GitHub templates for issues and pull requests
  • Reorganized a section of the README.md

Results

  • issue labels automatically assigned (test here)

Screen Shot 2021-04-26 at 5 52 44 PM

  • "Using vtk.js" section in README.md (visible here)

Testing

N/A, doc/chore only

@agirault agirault requested review from aylward and jourdain April 26, 2021 21:51
@agirault
Copy link
Contributor Author

FYI @daker, thanks for the initial work on this!

@agirault agirault force-pushed the new-issue-templates branch from 4659b3e to 443e12c Compare April 26, 2021 21:55
jourdain
jourdain approved these changes Apr 26, 2021
View reviewed changes
Copy link
Collaborator

@jourdain jourdain left a comment

Choose a reason for hiding this comment

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

LGTM

@agirault agirault force-pushed the new-issue-templates branch from 443e12c to b078eb8 Compare April 26, 2021 21:59
@daker
Copy link
Collaborator

daker commented Apr 26, 2021

@agirault regarding the documentation, we did start a big chunk of work where we add typescript definitions which also includes the documentation, and remove api.md progressively.

.d.ts: https://github.com/Kitware/vtk-js/blob/master/Sources/Rendering/Core/Camera/index.d.ts
online: https://kitware.github.io/vtk-js/api/Rendering_Core_Camera.html

@agirault
Copy link
Contributor Author

@daker: nice! Do you recommend we update the CONTRIBUTING.md doc to document that? Or were you thinking of something in those current changes?

@daker
Copy link
Collaborator

daker commented Apr 26, 2021

@agirault it would be good if it's added to the pull request template, so we can keep the JS & TS api in sync

[ ] Documentation and TS defs was updated to match those changes

@agirault
Copy link
Contributor Author

agirault commented May 5, 2021

@daker I'm looking back at this. I can't find any other mention of the TS doc apart from your comment above. Ideally, we could address this, then update the PR template to link to that as well. Thoughts?

Alexis Girault added 2 commits May 5, 2021 16:41
chore(.github): Improve github templates
df03201 
- update issue tenplates to match issue labels
- improve content of pull request template
doc(README): Improve layout and doc+support info
30a699f
@agirault agirault force-pushed the new-issue-templates branch from b078eb8 to 30a699f Compare May 5, 2021 20:41
@agirault agirault merged commit 289257b into Kitware:master May 7, 2021
@github-actions
Copy link

🎉 This PR is included in version 18.0.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@github-actions github-actions bot added the released Automated label label May 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jourdain jourdain jourdain approved these changes

@aylward aylward Awaiting requested review from aylward

Assignees
No one assigned
Labels
released Automated label
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Improve contributing documentation
3 participants
@agirault @daker @jourdain