Skip to content

Latest commit

 

History

History
121 lines (96 loc) · 4.79 KB

CONTRIBUTING.md

File metadata and controls

121 lines (96 loc) · 4.79 KB
Raw

Contributing to getmac

Thanks for taking an interest in this awesome little project. We love to bring new members into the community, and can always use the help.

Resources

Code requirements

  • Must work under all supported Python versions (2.7 and 3.4+)
  • Must work on all supported platforms (if applicable)
  • Try to match the general code style (loosely PEP8)
  • Be respectful. Memes, references, and jokes are ok. Explicit language (cursing/swearing), NSFW text/content, or racism are NOT ok.

Checklist before submitting a pull request

  • Code is formatted using black (black getmac tests)
  • All tests run and pass locally
    • tox
    • tox -e check
  • Update the CHANGELOG (For non-trivial changes, e.g. changing functionality or adding tests)
  • Add your name to the contributors list in the README

Checklist before a Pull Request will be merged

  • All tests pass in GitHub Actions
  • Code has been reviewed by at least one maintainer

Where to contribute

Good for beginners

  • Sample collection (see section below)
  • Platform testing (see section below)
  • Bug reports!
  • Documentation (including fixes for grammar and spelling)
  • Improving and adding tests for existing samples

Main areas of focus

  • Writing parsers for new commands (Example: netsh int ipv6)
  • Addressing missing functionality (Example: default interface detection for IPv6 on Windows)
  • Adding new features (Example: ability to find MAC by interface index integer)
  • Adding tests for internal methods and mocking where necessary

Platform testing

Help is dearly needed on testing and rooting out differences in various platforms and configurations. At a basic level, this involves just running the tests on any platforms you use. Open issues for any bugs or quirks you discover, or if you're feeling adventurous, fix it yourself!

Any platform is fair game! The following are some highlights or platforms of special interest:

  • MacOS/OSX (This requires owning a Mac, and is the area most sorely in need of testing)
  • Legacy Windows desktop (7 and 8)
  • Windows Server
  • Arch Linux
  • BSD

Sample collection

Examples of output of various commands is an easy way contribute that is still incredibly helpful.

  1. Run the command
  2. Copy/paste the output (or redirect output of command, tee is helpful here) into an appropriately named .out file in samples/
  3. That's it!

Getting started

  1. Create your own fork of the code through GitHub web interface (Here's a Guide)
  2. Clone the fork to your computer. This can be done using the GitHub desktop GUI , git clone <fork-url>, or the Git tools in your favorite editor or IDE.
  3. Create and checkout a new branch in the fork with either your username (e.g. "ghostofgoes"), or the name of the feature or issue you're working on (e.g. "openbsd-support"). Again, this can be done using the GUI, your favorite editor, or git checkout -b <branch> origin/<branch>.
  4. Install the developer tools and getmac as an "editable" package: 
    python -m pip install --user -U tox
python -m pip install -e .
  5. Setup and run the tests: 
    # Run code quality checks
tox -e check

# Run the tests
tox
  6. Write some code! Git commit messages should information about what changed, and if it's relevant, the rationale (thinking) for the change.
  7. Follow the checklist in the pull request template
  8. Submit a pull request!

Bug reports

Filing a bug report:

  1. Answer these questions:
    • What version of getmac are you using? (getmac --version)
    • What operating system and processor architecture are you using?
    • What version of Python are you using?
    • What did you do?
    • What did you expect to see?
    • What did you see instead?
  2. Put any excessive output into a GitHub Gist and include a link in the issue.
  3. Tag the issue with "Bug"

NOTE: If the issue is a potential security vulnerability, do NOT open an issue! Instead, email: ghostofgoes(at)gmail(dot)com

Features and ideas

Ideas for features or other things are welcomed. Open an issue on GitHub detailing the idea, and tag it appropriately (e.g. "Feature" for a new feature).

Resources

Regex resources (regular expressions)