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

Create documentation of the contribution process - adding and implementing issues and submitting PRs #190

Closed
rjyounes opened this issue Feb 27, 2020 · 9 comments
Assignees
Labels
area: documentation effort: small Requires less than one day to complete impact: patch No new functionality or changes in human-readable semantics (e.g,. fixing a typo in an annotation)

Comments

@rjyounes
Copy link
Collaborator

rjyounes commented Feb 27, 2020

Add guidelines for issue submission to documentation folder.

E.g., be specific in titles (not "typo in label" but specifically which label).
Include gist version number in the description (not title).

To submit a PR:

  • create issue first
  • submit PR referencing issue (I.e. "fixes #xx")
@uscholdm
Copy link
Contributor

uscholdm commented Mar 2, 2020

Include in the recommendations suggestions for solutions, where possible.

@rjyounes rjyounes changed the title Create guidelines for issue submission Create guidelines for issue and PR submission Mar 2, 2020
@rjyounes rjyounes added effort: small Requires less than one day to complete impact: patch No new functionality or changes in human-readable semantics (e.g,. fixing a typo in an annotation) labels Mar 2, 2020
@rjyounes
Copy link
Collaborator Author

rjyounes commented Mar 2, 2020

Include issue and PR submission by non-SA contributors

@rjyounes rjyounes changed the title Create guidelines for issue and PR submission Create guidelines for outside contributors (issues and PRs) Mar 2, 2020
@rjyounes
Copy link
Collaborator Author

I moved everything from the wiki page into GitHub. I think there may need to be some separation between internal and public documentation, so this needs some refinement.

@rjyounes rjyounes changed the title Create guidelines for outside contributors (issues and PRs) Create documentation of the change process, including guidelines for submission of issues and PRs Mar 12, 2020
@rjyounes
Copy link
Collaborator Author

rjyounes commented Mar 30, 2020

Should move everything from wiki to GitHub to keep everything in one place, but remove references to, e.g., individual people. Use term "repository admins" for those who have merge permission to develop.

@rjyounes
Copy link
Collaborator Author

rjyounes commented Apr 6, 2020

See https://help.github.com/en/github/building-a-strong-community/setting-guidelines-for-repository-contributors. Should follow this model.

  • Change doc directory to docs
  • File is Contributing.md

@rjyounes
Copy link
Collaborator Author

@sa-bpelakh See preceding comment - there are benefits to follow GitHub in putting this file in a folder called docs rather than doc, so I'd like to rename the folder as part of this issue. Is there an ontology-toolkit config file that needs to be updated? I'm assuming now no changes are required to ontology-toolkit itself.

@sa-bpelakh
Copy link
Collaborator

@rjyounes I have not issue w/ renaming the folder. The bundle template that is part of #225 (for which I have requested your review 😄 ) will need to modified, but that's all.

@rjyounes
Copy link
Collaborator Author

Aha, that explains it: I was looking for such a file but couldn't find one!

@rjyounes rjyounes changed the title Create documentation of the change process, including guidelines for submission of issues and PRs Create documentation of the contribution process - adding and implementing issues, and submitting PRs Apr 23, 2020
@rjyounes
Copy link
Collaborator Author

Scaled this issue back to refer just to Contributing.md. Other issues have been created for other documents: #232, #233.

@rjyounes rjyounes changed the title Create documentation of the contribution process - adding and implementing issues, and submitting PRs Create documentation of the contribution process - adding and implementing issues and submitting PRs Apr 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation effort: small Requires less than one day to complete impact: patch No new functionality or changes in human-readable semantics (e.g,. fixing a typo in an annotation)
Projects
None yet
Development

No branches or pull requests

3 participants