Issue/127/contributing

[tallamjr]

Major updates to CONTRIBUTING.md file

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

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

[Catarina-Alves]

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.

[rbiswas4]

@tallamjr very good idea. Of what I just saw: I suggest changing
- [ ] I am up to date with `dev` branch via `git rebase dev` at the time of this PR
which will only look at the user's local branch to
- [ ] I am up to date with `dev` branch via `git pull --rebase origin dev` at the time of this PR
which will pull the latest dev branch from github.

A warning might be in order, as sometimes rebase can get into a merge problem, which might discourage a user. If this happens, the user can always do git rebase --abort and submit the PR without checking the box. In any case, the rebase needs to happen at the time the PR is merged.

[tallamjr]

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.

Yep @Catarina-Alves . The user will see a screen like this :

Where if you don't want to open a [BUG] or [FEATURE] issue you can "Open a regular issue" at the bottom. This is effectively what General is, which just opens a plain issue but gives the user a button to select this option.

In light of @rbiswas4 comments, I will update this PR with those suggested changes 👍

[Catarina-Alves]

Yep @Catarina-Alves . The use will see a screen like this :

Where if you don't want to open a [BUG] or [FEATURE] issue you can "Open a regular issue" at the bottom. This is effectively what General is, which just opens a plain issue but gives the user a button to select this option.

Cool, I had not noticed those words in the bottom.

In light of @rbiswas4 comments, I will update this PR with those suggested changes 👍

After reviewing your changes that I will approve it.

[Catarina-Alves]

Seems good.

[tallamjr]

Closes #126 , #127