-
Notifications
You must be signed in to change notification settings - Fork 5
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
Issue/127/contributing #130
Conversation
Moving file to top level of repo to be a single file that describes how users can contribute to the snmachine project
These files allow for templating of issues and pull requests on Github for easier contributions. The layout is akin to: https://github.com/tallamjr/dotfiles/issues/new/choose where one chooses an issue option, BUG, FEATURE_REQUEST, or just make a general issue. In addition, a PULL_REQUEST_TEMPLATE has been created to allow for consistent documentation of what a PR achieves. Fixes #126
In addition to Code Style section, further subsections have been added such as: * Creating an Issue * Submitting a Pull Request * Running Tests Locally * Package Versioning Some sections anticipate adoption of certain practises that have not been implemented yet, such as CHANGELOG, but this should be in place in due course. Therefore this commit links to #129 Closes #127
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For what I can see we will be able to choose between:
- Bug
- Feature request
- General
Did I understand it? I just want to make sure it is possible to create an issue that is not a bug nor a feature request. I am thinking about times when we might want to re-do some parts of the code (eg: replace a certain name for a more explanatory one) and that is not a bug nor a feature.
@tallamjr very good idea. Of what I just saw: I suggest changing A warning might be in order, as sometimes |
Yep @Catarina-Alves . The user will see a screen like this : Where if you don't want to open a In light of @rbiswas4 comments, I will update this PR with those suggested changes 👍 |
Cool, I had not noticed those words in the bottom.
After reviewing your changes that I will approve it. |
Moving instructions for how to update the contributors repo with snmachine into a hidden comment, as opposed to being inline with the check mark. Since it is outlined in CONTRIBUTING.md that one should fork snmachine and then make changes in their local repo, it is expected that they should update the dev branch from "upstream"
As well as fixing typo and upper-casing github --> Github
60d6eb0
to
fde186a
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Seems good.
Major updates to CONTRIBUTING.md file
In addition to Code Style section, further subsections have been added
such as:
Some sections anticipate adoption of certain practises that have not
been implemented yet, such as CHANGELOG, but this should be in place in
due course. Therefore this commit links to #129
Closes #127
Adding Github ISSUE/PR templates
These files allow for templating of issues and pull requests on Github
for easier contributions.
The layout is akin to:
https://github.com/tallamjr/dotfiles/issues/new/choose
where one chooses an issue option, BUG, FEATURE_REQUEST, or just make a
general issue.
In addition, a PULL_REQUEST_TEMPLATE has been created to allow for
consistent documentation of what a PR achieves.
Fixes #126