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.

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

[DISQ-6] Add CONTRIBUTING and SUPPORT files. #15

Merged
merged 2 commits into from
Oct 19, 2018
Merged

[DISQ-6] Add CONTRIBUTING and SUPPORT files. #15

merged 2 commits into from
Oct 19, 2018

Conversation

heuermh
Copy link
Contributor

@heuermh heuermh commented Jul 19, 2018 •
edited
Loading

Fixes #6.

magicDGS
magicDGS reviewed Jul 19, 2018
View reviewed changes
Copy link
Contributor

@magicDGS magicDGS left a comment

Choose a reason for hiding this comment

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

Is this suposed to be for the whole DISTQ-BIO community, or for only this repo?

CONTRIBUTING.md Outdated
@@ -0,0 +1,9 @@
How to contribute to disq-bio
Copy link
Contributor

Choose a reason for hiding this comment

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

Shouldn't this be DISQ?

CONTRIBUTING.md Outdated
How to contribute to disq-bio
=============================

Thank you in advance for contributing to disq-bio!
Copy link
Contributor

Choose a reason for hiding this comment

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

Same

SUPPORT.md Outdated
@@ -0,0 +1,20 @@
How to get support for disq-bio
Copy link
Contributor

Choose a reason for hiding this comment

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

Same

SUPPORT.md Outdated
provide context for your issue. The [How to submit a contribution](https://opensource.guide/how-to-contribute/)
Open Source Guide is very helpful in this regard.

Thank you for contributing to disq-bio!
Copy link
Contributor

Choose a reason for hiding this comment

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

The same

@tomwhite
Copy link
Member

+1

magicDGS
magicDGS reviewed Jul 24, 2018
View reviewed changes
CONTRIBUTING.md Outdated

Thank you in advance for contributing to disq-bio!

[todo]
Copy link
Contributor

Choose a reason for hiding this comment

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

I realized that you added to every PR the [DISQ-{{issue_number}}] and that should be documented somewhere, in addition to add the Fixes/Closes #{{issue_number}} for cross-reference. On the other hand, what's about PRs without associated issue?

Maybe a good starting point to add something to this file?

@heuermh
Copy link
Contributor Author

heuermh commented Sep 24, 2018

Ping for review and merge. I realize these are a bit weak on content, but I'd rather get them in place now and add to them as things settle out.

magicDGS
magicDGS requested changes Sep 25, 2018
View reviewed changes
CONTRIBUTING.md
### Search the Github issue tracker and pull requests

Before creating a new issue or pull request, please search the [Disq issue tracker](https://github.com/disq-bio/disq/issues)
and [Disq open pull requests](https://github.com/disq-bio/disq/pulls) on Github.
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe instead of repeat here the same as in SUPPORT.md, it might be better to say where to find the support information (the other file) and link here with markdown.

CONTRIBUTING.md
@@ -0,0 +1,12 @@
How to contribute to Disq
Copy link
Contributor

Choose a reason for hiding this comment

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

As I mentioned in #13, I wouldadd a section about how to write distq in the project files (package names, java classes, markdown documentation, javadoc, etc.). That is a good point to start to set proper developmental guidelines...

Copy link
Contributor

Choose a reason for hiding this comment

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

Also, I would add a PR-guidelines to setup naming conventions ([DISQ-#] Description, as I can see in the current ones) and mentioning which issue is resolving. Also, it looks like each PR should point to an issue, and thus this should also be mentioned in the contributing guidelines...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Created issue #39

SUPPORT.md
and [Disq open pull requests](https://github.com/disq-bio/disq/pulls) on Github.


### Create a new issue on Github
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe out of the scope of this PR, but it might be usefull to add a PR/issue template for github (and link it here too).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good idea, created issue #38

@magicDGS
Copy link
Contributor

I think that it is better to add some of the content that looks already assumed, as it is easier to track in a live document like the CONTRIBUTING.md file...

@tomwhite tomwhite self-requested a review September 25, 2018 09:03
tomwhite
tomwhite approved these changes Sep 25, 2018
View reviewed changes
Copy link
Member

@tomwhite tomwhite left a comment

Choose a reason for hiding this comment

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

+1 to merging as-is and improving with follow-on PRs.

This was referenced Sep 25, 2018
Open
Closed
@heuermh
Copy link
Contributor Author

heuermh commented Sep 25, 2018

Created new issues to track suggestions made by @magicDGS, thanks!

@heuermh heuermh mentioned this pull request Oct 17, 2018
Closed
@tomwhite
Copy link
Member

Can this be merged now @magicDGS, @heuermh?

@tomwhite tomwhite added this to the 0.1.0 milestone Oct 18, 2018
@magicDGS
Copy link
Contributor

👍

@heuermh
Copy link
Contributor Author

heuermh commented Oct 18, 2018

Yes, this can be merged

@tomwhite tomwhite merged commit 4e9e72f into disq-bio:master Oct 19, 2018
@tomwhite
Copy link
Member

Thanks @heuermh and @magicDGS!

@magicDGS
Copy link
Contributor

Thank you too!

@heuermh heuermh deleted the contributing branch October 19, 2018 17:44
@heuermh
Copy link
Contributor Author

heuermh commented Oct 19, 2018

Thank you, @tomwhite

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@magicDGS magicDGS magicDGS requested changes

@tomwhite tomwhite tomwhite approved these changes

Assignees

@heuermh heuermh

Labels
None yet
Projects
None yet
Milestone
0.1.0
Development

Successfully merging this pull request may close these issues.
3 participants
@heuermh @tomwhite @magicDGS