Skip to content

Latest commit

 

History

History
206 lines (147 loc) · 8.09 KB

CONTRIBUTING.md

File metadata and controls

206 lines (147 loc) · 8.09 KB
Raw

Contributing to niet

First off, thanks for taking the time to contribute!

The following as a set of guidelines for contributing to niet. These are mostly guidelines, not rules. Use your best judgment, and fell free to propose changes to this document in a pull request.

Code of Conduct

This project and everyone participating in it is governed by the niet Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to herveberaud.pro@gmail.com.

How Can I Contribute?

Reporting Bugs

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

Before creating bug reports, please perform a cursory search to see if the problem has already been reported. If it has and the issue is still open, add a comment to the existing issue instead of opening a new one. When you are creating a bug report, please include as many details as possbile.

Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.

How Do I Submit A (Good) Bug Report?

Bugs are tracked as GitHub issues.

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. For example, start by explaining how you use the niet command line, e.g. which command exactly you used in the terminal. When listing steps, don't just say what you did, but explain how you did it.
  • 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.

Provide more context by answering these questions:

  • Did the problem start happening recently (e.g. after updating to a new version of niet) or was this always a problem?
  • If the problem started happening recently, can you reproduce the problem in an older version of niet? What's the most recent version in which the problem doesn't happen? You can install older versions of niet from the pypi repository.
  • Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.

Include details about your configuration and environment:

  • Which version of niet are you using? You can get the exact version by running pip freeze | grep "niet" in your terminal.
  • What's the name and version of the OS you're using?
  • What's the version of python you're using?

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for niet, 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 and including the steps that you imagine you would take if the feature you're requesting existed.

How Do I Submit A (Good) Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues.

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 or point out the part of niet which the suggestion is related to. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.
  • Explain why this enhancement would be useful to most niet users.
  • List some other tools or applications where this enhancement exists.
  • Specify which version of niet you're using. You can get the exact version by running pip freeze| grep "niet" in your terminal.
  • Specify the name and version of the OS you're using.
  • Specify the version of python you're using

Code Contribution

Hacking on niet

If you're hitting a bug in niet or just want to experiment with adding a feature, follow these steps.

Prerequisites

  • tox
  • python 2.7+

Cloning

$ git clone https://github.com/openuado/niet

Setup your environment

From there, you can navigate into the directory where you've cloned the niet source code:

$ cd niet

You can install the development tools by using:

python3.11 -m pip install --editable ".[dev]"

And enabling pre-commit for niet:

$ pre-commit install

tox allow you to use niet directly in a dedicated virtual environment already configured (requirements, etc):

$ tox -e venv -- niet -h
...
venv run-test: commands[0] | niet -h
usage: niet [-h] [-f {json,yaml,eval,newline,ifs,squote,dquote}] [-i]
            [-o OUTPUT_FILE] [-s] [-v]
            object [file]
...
___________________ summary ______________
  venv: commands succeeded
  congratulations :)

$ tox -e venv -- niet -v
niet version <related version>

Make your changes

First create your working branch:

$ git checkout -b somefeature origin/master

Be sure to create your working branch from master and be sure your master are up-to-date

Make our changes:

$ vim <file-to-edit>
$ git commit -am 'I did some changes'

Notice that a debug mode is available and can be easily used during your development to dive deep in your execution and observe what happen step by step, example:

tox -e venv -- niet --debug \
    oslo.deliverables\
    https://raw.githubusercontent.com/openstack/governance/master/reference/projects.yaml

Ensure everything work fine

Every following checks are automaticaly executed on pull requests so need to be sure that all of these checks run successfully before submit your pull request on github.

Code formating and PEP8 validation:

$ tox -e pep8

Unit tests:

$ tox # by default run tests with all the python versions specified in tox.ini

Note: If you have just a specific version of python installed on your system, you can test like this:

$ tox -e py311 # test with python 3.11

Security analyze:

bandit -r niet

Pull Requests

If everything work fine you can create your pull request.

Before ensure you have squash your commits.

Be sure to submit your pull request on the upstream master branch!

You can create your pull request manually directly from github:

  • Include examples, outputs, etc... whenever possible.
  • Include screenshots and animated GIFs in your pull request whenever possible.

Deploy niet on PyPi

pip install --editable ".[dev]"
python -m build
twine check dist/*
twine upload dist/*