dptech-corp / Uni-Dock-Dev

Uni-Dock: a GPU-accelerated molecular docking program
0 stars 0 forks source link

[Tutorial] Collaboration Guidelines with All Contributors #8

Closed zhengh96 closed 8 months ago

zhengh96 commented 9 months ago

We are now practicing a collaboration standard, which is to first list the required features through Github Issues, then develop them, and associate the Pull Requests that have completed the development to the corresponding Issues. We expect this specification to become a consensus for Uni-Dock contributors, please indicate it in the README.

zhengh96 commented 9 months ago

I DO think the open source collaboration in the main Uni-Dock repo is the most appropriate solution, but now it seems a bit abrupt to collaborate directly on the main repo in a new organizational form (the Issue driven form).

So we first use the Uni-Dock-Dev repo to complete the development of Uni-Dock v1.1 and the refactor-like issues, and add the collaboration standard to the README (as described in this issue).

Then we switch to the Uni-Dock main repo for collaboration.

caic99 commented 9 months ago

I DO think the open source collaboration in the main Uni-Dock repo is the most appropriate solution, but now it seems a bit abrupt to collaborate directly on the main repo in a new organizational form (the Issue driven form).

So we first use the Uni-Dock-Dev repo to complete the development of Uni-Dock v1.1 and the refactor-like issues, and add the collaboration standard to the README (as described in this issue).

Then we switch to the Uni-Dock main repo for collaboration.

Agreed. I will draft a contribution guideline following the open source best practices.

zhengh96 commented 9 months ago

I think we could also plan the design of the content to be displayed in the README at the root level of the Uni-Dock Repo, such as a basic introduction, collaboration guidelines, recent updates, and so on.

Any ideas? @ysyecust @caic99 @YNYuan

zhengh96 commented 9 months ago

We may follow this recommendation.

zhengh96 commented 8 months ago

Two ideas:

[Feature Request]
> A clear and concise description of what the problem is.
[Possible Solution (Optional)]
> A clear and concise description of what you want to happen.
[Alternative Solution (Optional)]
> A clear and concise description of any alternative solutions or features you've considered.
[Additional Context (Optional)]
> Add any other context or screenshots about the feature request here.
caic99 commented 8 months ago

Two ideas:

  • Add title with issue type automatically
  • Optimize the context template

Implemented in #34 using issue forms.