Skip to content

Latest commit

 

History

History
145 lines (82 loc) · 5.43 KB

CONTRIBUTING.md

File metadata and controls

145 lines (82 loc) · 5.43 KB
Raw

Contributing to Needle

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to Needle, which is hosted in the MWRLabs Organization on GitHub.

These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.

What should I know before I get started?

For a description of Needle's architecture, folder structure, APIs, and module templates, please refer to the Architecture page on the Wiki.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for Needle. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻 💻, and find related reports 🔎.

When you are creating a bug report, please include as many details as possible. If you'd like, you can use this template to structure the information.

How Do I Submit A (Good) Bug Report?

Bugs are tracked as GitHub issues. After you've determined which component your bug is related to, create an issue and provide the following information.

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

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible.
  • Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.
  • Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem.
  • If the problem wasn't triggered by a specific action, describe what you were doing before the problem happened and share more information using the guidelines below.

Template For Submitting Bug Reports

## Issue

### Expected behaviour
Tell us what should happen.

### Actual behaviour
Tell us what happens instead.

### Steps to reproduce
1.
2.
3.

### needle error logs
Ensure verbose and debug mode are enabled:

  [needle] > set VERBOSE True
  VERBOSE => True
  [needle] > set DEBUG True
  DEBUG => True

## Environment

#### Workstation Operating System

#### Python Version

#### Python Packages (`pip freeze`)

#### Device iOS Version

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for Needle, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion 📝 and find related suggestions 🔎.

When you are creating an enhancement suggestion, please include as many details as possible. If you'd like, you can use this template to structure the information.

How Do I Submit A (Good) Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues. After you've determined which component your enhancement suggestions is related to, create an issue and provide the following information:

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • Include screenshots and animated GIFs which help you demonstrate the steps.

Template For Submitting Enhancement Suggestions

## Enhancement

### Expected behaviour
Tell us what should happen.

### Actual behaviour
Tell us what happens instead.

### Steps which explain the enhancement
1.
2.
3.

Your First Code Contribution

Unsure where to begin contributing? You can start by looking through:

Pull Requests

  • Use the develop as target branch.
  • Include screenshots in your pull request whenever possible.
  • Follow the styleguides whenever possible.
  • Document new code.

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally

Python Styleguide

Python code should adhere (as much as possible) to PEP 8.