Skip to content

Latest commit

 

History

History
80 lines (53 loc) · 2.2 KB

CONTRIBUTING.md

File metadata and controls

80 lines (53 loc) · 2.2 KB
Raw

Contributing

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

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

Preferred contributions

At the moment, these kind of contributions are more appreciated and should be preferred:

  • Fix for issues described in Known Issues
  • New cool features. Please propose your features in an issue first.
  • Code optimizations: any optimization to the code is welcome

For any other kind of contribution, especially for new features, please submit an issue first.

Pull Request Process

  1. Write your code.
  2. Write a properly documentation compliant with reStructuredText.
  3. Write tests for your code. Code coverage for your code must be at least at 90%. See Tests Units to know more!
  4. Report changes to the issue you opened.
  5. Update the README.md and other docs with details of changes to the interface, this includes new line in the changelog, new modules if added, new command line options if added, etc.
  6. Request maintainers to merge your changes.

Developer's guide

Want to know more about how ATtila works?
Check out the Developers guide

Tests Units

ATtila is provided with tests units, which can be found under tests/ directory. To launch test unit just type:

nosetests -v --with-coverage --cover-tests --cover-package=attila --nocapture tests/

Don't you have nose?

sudo -H pip3 install nose coverage unittest2 codecov

Linting and format

This is the current configuration for linting and format:

for code format, we use Black

pip3 install black

with the default configuration.

For linting we use flake8

pip3 install flake8

and has to be run with:

flake8 attila/

Thank you for any contribution! 🧡
Christian Visintin