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

Proposed CONTRIBUTING.md file using a standardized template #14

Merged
merged 2 commits into from
Apr 20, 2022
Merged

Proposed CONTRIBUTING.md file using a standardized template #14

merged 2 commits into from
Apr 20, 2022

Conversation

riverma
Copy link
Collaborator

@riverma riverma commented Apr 19, 2022

Purpose

  • New CONTRIBUTING.md file format
  • Leveraging https://nasa-ammos.github.io/slim/documentation/starter-kits/#contributing-guide-template
  • NOTE: this is a DRAFT pull-request and it needs to be customized / adapted to your repo - please commit to this PR branch with your customizations before merging!
  • NOTE: make your modifications by searching for the string INSERT in the file and replacing with appropriate values for your repo
  • NOTE: read through the file thoroughly to ensure its well adapted for your repo and your scenario, feel free to modify as needed

Proposed Changes

  • [ADD] CONTRIBUTING.md file with sample content

Testing

riverma and others added 2 commits April 19, 2022 16:53
- Filled out all sections
- Updated diagrams to make process / flow more understandable
@riverma riverma marked this pull request as ready for review April 20, 2022 22:56
@riverma riverma merged commit 9373f25 into NASA-AMMOS:main Apr 20, 2022
@jpl-jengelke
Copy link
Contributor

jpl-jengelke commented Apr 20, 2022

My concern with the contribution guide is the split arrow in the diagram that implies a PR can be duplicated between two repos. PRs are tied to repos in a 1:1 correspondence. So PR comments/metadata/metachanges on a forked repo will be not be seen in the main ("our repository") repo. I would remove the arrow that goes back to the forked repo with the PR. If users comment there it will be them commenting on the fork only. (PRs aren't carried with merges, only the content itself.) Sure, the content will be retained but I think there's value in documenting the process as well as the comments. Also, it's not customary for PRs on the fork to be the source of review -- gatekeeper is the PR on the main repo.

See image:
Screen Shot 2022-04-20 at 4 46 03 PM

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