You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
1. Expanding the existing codebase with new features or improvements to existing ones. Use the "Feature Request" label.
2. Contributing to or improving the project's documentation and examples (located in `hssm/examples`). Use the "Documentation" label.
3. Rectifying issues with the existing codebase. These can range from minor software bugs to more significant design problems. Use the "Bug" label.
It's not clear to me where/when these labels are to be used. Should an issue be created first and add the suggested label? Or should the labeling be used in a PR?
It feels like this block should be under the Opening Issues section. That would clarify where the labeling should be used.
The preferred workflow for contributing to HSSM is to fork the GitHub repository, clone it to your local machine, and develop on a feature branch.
I think expanding the meaning of fork, clone, feature branch would be beneficial. Maybe adding short definitions/descriptions would be useful for new contributors reading this guide.
I think that if people are using ssh, they are very likely to understand this workflow already. I'd remove these commands to make the document simpler.
> Warning: Always create a new feature branch before making any changes. Make your changes in the feature branch. It’s good practice to never routinely work on the main branch of any repository.
Suggestion
Warning
Routinely making changes in the main branch of a repository should be avoided. Always create a new feature branch before making any changes and make your changes in the feature branch.
Remove listing about poetry installing
It's not clear to me why this is required/advantageous. Can't users add their changes locally and test them without poetry? I think this section would need to be expanded (in a separate advanced subsection?) if new dependencies are needed and how to use poetry to manage that.
Re 1:
These are probably meant more as high level concepts that specific contribution guidelines at that point. It's an option to expand it into concrete guidelines for labeling PRs not against it.
Re 2:
Agree that we should probably add short definitions on this (possibly some links)
Re 3:
Agree
Re 4:
Agree
Re 5:
Also agree that it's probably best to not make it seem that poetry is a must.
HSSM/docs/CONTRIBUTING.md
Lines 7 to 9 in 581c0fd
It's not clear to me where/when these labels are to be used. Should an issue be created first and add the suggested label? Or should the labeling be used in a PR?
It feels like this block should be under the Opening Issues section. That would clarify where the labeling should be used.
HSSM/docs/CONTRIBUTING.md
Line 19 in 581c0fd
I think expanding the meaning of fork, clone, feature branch would be beneficial. Maybe adding short definitions/descriptions would be useful for new contributors reading this guide.
HSSM/docs/CONTRIBUTING.md
Lines 27 to 31 in 581c0fd
HSSM/docs/CONTRIBUTING.md
Lines 41 to 46 in 581c0fd
I think that if people are using ssh, they are very likely to understand this workflow already. I'd remove these commands to make the document simpler.
HSSM/docs/CONTRIBUTING.md
Line 62 in 581c0fd
Suggestion
Warning
Routinely making changes in the main branch of a repository should be avoided. Always create a new feature branch before making any changes and make your changes in the feature branch.
It's not clear to me why this is required/advantageous. Can't users add their changes locally and test them without poetry? I think this section would need to be expanded (in a separate advanced subsection?) if new dependencies are needed and how to use poetry to manage that.
Thoughts? @digicosmos86 @AlexanderFengler
The text was updated successfully, but these errors were encountered: