Skip to content

Latest commit

 

History

History
85 lines (67 loc) · 4.79 KB

CONTRIBUTING.md

File metadata and controls

85 lines (67 loc) · 4.79 KB
Raw

Contributing to GITS2.0 - I.R.I.S (Ideal ReposItory for Software projects)

Thank you so much for taking an interest in contributing! There are many ways to contribute to this project.

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct (CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.

Pull Request Process

  1. Maintain GITS2.0 - I.R.I.S project quality.
  2. Should have appropriate ISSUE linked with the Pull request.
  3. The PR should be assigned to the individual requesting a merge.
  4. The Reviewers must approve the pull request before merging the code.
  5. The description should be updated as to what has been asked in the issue.
  6. All the development code should accompany unit test cases to support the validation results.
  7. Travis Builds should be passing while the code is generated.
  8. The development code should be style checked, well-formatted and syntax error free. Use of pep8, autoflake8 and flake8 tools will enable the users to get the required code quality.
  9. Commit messages should company details of the changes been made.

Bug Reporting Process

Bugs are tracked as GitHub issues. You need to create an issue and include all the following details if possible.

Explain the problem and include additional details to help maintainers reproduce the problem:

  1. Before raising a GitHub issue, make sure that you are running the latest version of the application and have all recommended OS updates / patches installed
  2. Use a clear and descriptive title for the issue to identify the problem.
  3. Describe the exact steps which reproduce the problem in as many details as possible. For example, start by explaining how you started Atom, e.g. which command exactly you used in the terminal, or how you started Atom otherwise. When listing steps, don't just say what you did, but explain how you did it. For example, if you moved the cursor to the end of a line, explain if you used the mouse, or a keyboard shortcut or an Atom command, and if so which one?
  4. Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/paste-able snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
  5. Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  6. Explain which behavior you expected to see instead and why.
  7. Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem.

Enhancement suggestion process / Feature request Process

Bugs are tracked as GitHub issues. You need to create an issue and include all the following details if possible.

  1. Use a clear and descriptive title for the issue to identify the suggestion.
  2. Provide a step-by-step description of the suggested enhancement in as many details as possible.
  3. Provide specific examples to demonstrate the steps.
  4. Describe the current behavior and explain which behavior you expected to see instead and why.
  5. Explain why this enhancement would be useful to most users and isn't something that can or should be implemented as a community package.

Adding new command

  1. Create a new file in PROJECT HOME/code/gits_.py

  2. Follow the template below to create a new command and update the values in text with appropriate values

    from subprocess import Popen, PIPE
import gits_logging

def gits__command name_(args):
    try:
        #Repeat the following code to execute multiple commands
        command = "_command to be executed_"
        process_commands = command.split()
        process = Popen(process_commands, stdout=PIPE, stderr=PIPE)
        stdout, stderr = process.communicate()
    except Exception as e:
        gits_logging.gits_logger.error("gits _command name_ command caught an "
            + "exception")
        gits_logging.gits_logger.error("{}".format(str(e)))
        print("ERROR: gits _command name_ command caught an exception")
        print("ERROR: {}".format(str(e)))
        return False
    return True

  3. Add the following entries in PROJECT HOME/code/gits.py

    from gits__command name_ import gits__command name_
.
.
gits__command name__subparser = subparsers.add_parser("_command name_")
gits__command name__subparser.add_argument("<argument variable1>", help = "_description of the variable_")
gits__command name__subparser.add_argument("<argument variable2>", help = "_description of the variable_")
.
.
gits__command name__subparser.set_defaults(func=gits__command name_)