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 CONTRIBUTING.md #617

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

pbuttigieg
Copy link
Collaborator

Started the extension of the CONTRIBUTING.Md doc - more content should be added so devs know what and how to edit to maintain and extend MIxS.

Closes #615

@pbuttigieg pbuttigieg added enhancement documentation-internal For MIxS editors and policy makers labels Oct 17, 2023
@pbuttigieg pbuttigieg requested a review from turbomam October 17, 2023 16:27
@pbuttigieg pbuttigieg self-assigned this Oct 17, 2023
@pbuttigieg pbuttigieg linked an issue Oct 17, 2023 that may be closed by this pull request
@pbuttigieg
Copy link
Collaborator Author

pbuttigieg commented Oct 17, 2023

@turbomam @sujaypatil96 - this PR targets main.

Is that right or is there a branch to stage the release?

Copy link
Member

@turbomam turbomam left a comment

Choose a reason for hiding this comment

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

Thanks for starting this, @pbuttigieg. This can be expanded upon in the future.

@turbomam
Copy link
Member

turbomam commented Oct 19, 2023

@pbuttigieg: there's a merge conflict. Do you prefer for the issues and pulls links to appear before or after your new text about modifying mixs.yaml?

@pbuttigieg
Copy link
Collaborator Author

Before - that information is more general than my additions, so should appear first

@turbomam
Copy link
Member

turbomam commented Nov 6, 2023

I resolved the merge conflict by placing @pbuttigieg's new content after the links about issues and pull requests

@ramonawalls
Copy link
Collaborator

ramonawalls commented Dec 29, 2023

@pbuttigieg I think I havw covered or will cover this content in https://github.com/GenomicsStandardsConsortium/mixs/tree/606-mixs-editing-workflow-and-policy. May I close this PR without merging?

@cmungall
Copy link
Contributor

cmungall commented Apr 5, 2024

@ramonawalls

I think I havw covered or will cover this content in https://github.com/GenomicsStandardsConsortium/mixs/tree/606-mixs-editing-workflow-and-policy. May I close this PR without merging?

This linked to a long-running branch with many changes from multiple people. I made a PR for this to make it easier to see the changes:

https://github.com/GenomicsStandardsConsortium/mixs/pull/617/files

However, it looks like @pbuttigieg's PR has independent and useful contributions on how to find the yaml file to edit, etc, so I would like to merge this.

Also, can I make a plea for

  • smaller, incremental PRs
  • breaking larger pieces of work into smaller
  • no long running branches
  • always having a PR for each branch to make it more visible
  • faster decisions and merges on smaller PRs

Otherwise things get out of sync. This PR is from October. The linked PR is from 5 months ago. All of the good work in these PRs is not yet visible on the site. I know it's hard as we are volunteering time but some simple changes in practice can help us make use of our time more effectively

@mslarae13
Copy link
Contributor

Very old PR. Should we merge main and merge this?
@turbomam @pbuttigieg

@pbuttigieg
Copy link
Collaborator Author

@mslarae13 yes, but @turbomam to verify content is still current

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation-internal For MIxS editors and policy makers enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Extend CONTRIBUTING.Md for devs
5 participants