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.

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

Merged
merged 6 commits into from
May 13, 2019
Merged

Issue/127/contributing #130

merged 6 commits into from
May 13, 2019

Commits on May 8, 2019

  1. Rename conventions_for_pushes.md to CONTRIBUTING.md

    Moving file to top level of repo to be a single file that describes how
    users can contribute to the snmachine project
    tallamjr committed May 8, 2019
    Configuration menu
    Copy the full SHA
    f53c66c View commit details
    Browse the repository at this point in the history

Commits on May 9, 2019

  1. 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
    tallamjr committed May 9, 2019
    Configuration menu
    Copy the full SHA
    83d4eaa View commit details
    Browse the repository at this point in the history
  2. 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
    tallamjr committed May 9, 2019
    Configuration menu
    Copy the full SHA
    400a9cb View commit details
    Browse the repository at this point in the history

Commits on May 13, 2019

  1. Updating PR template

    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"
    tallamjr committed May 13, 2019
    Configuration menu
    Copy the full SHA
    85af28c View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    bc86a77 View commit details
    Browse the repository at this point in the history
  3. Minor comment on PEP8 E501 exception

    As well as fixing typo and upper-casing github --> Github
    tallamjr committed May 13, 2019
    Configuration menu
    Copy the full SHA
    fde186a View commit details
    Browse the repository at this point in the history