ATtila 1.2.0

CHANGELOG.md

@@ -0,0 +1,74 @@
+# Changelog
+
+- [Changelog](#changelog)
+ - [ATtila 1.2.0 (30/05/2020)](#attila-120-30052020)
+ - [ATtila 1.1.6 (25/03/2020)](#attila-116-25032020)
+ - [ATtila 1.1.5 (09/03/2020)](#attila-115-09032020)
+ - [ATtila 1.1.4 (05/03/2020)](#attila-114-05032020)
+ - [ATtila 1.1.3 (07/12/2019)](#attila-113-07122019)
+ - [ATtila 1.1.2 (29/10/2019)](#attila-112-29102019)
+ - [ATtila 1.1.1 (26/10/2019)](#attila-111-26102019)
+ - [ATtila 1.1.0 (26/10/2019)](#attila-110-26102019)
+ - [ATtila 1.0.4 (13/10/2019)](#attila-104-13102019)
+ - [ATtila 1.0.3 (12/10/2019)](#attila-103-12102019)
+
+## ATtila 1.2.0 (30/05/2020)
+
+- New ESK
+ - RTSCTS
+ - DSRDTR
+ - WRITE
+- ATtila CLI
+ - History
+- Changed minimum Python version to 3.5
+- Code
+ - Type annotations
+ - Indentation to 4 spaces
+
+## ATtila 1.1.6 (25/03/2020)
+
+- Fixed response collection
+
+## ATtila 1.1.5 (09/03/2020)
+
+- Fixed serial communication which didn't wait for all input
+ - Serial is now slower, especially for lower baudrate
+
+## ATtila 1.1.4 (05/03/2020)
+
+- Fixed slow serial read when working with low baud rates
+- Added ```rtscts=True, dsrdtr=True``` options to serial open
+- Serial Write is no more blocking
+- Fixed doppelganger and collectables
+
+## ATtila 1.1.3 (07/12/2019)
+
+- Fixed a typo in ATRE for ESK EXEC (commit ref: 8506523)
+
+## ATtila 1.1.2 (29/10/2019)
+
+- Fixed broken windows installation
+
+## ATtila 1.1.1 (26/10/2019)
+
+- Didn't deploy virtual.
+
+## ATtila 1.1.0 (26/10/2019)
+
+- Fixed device not None after serial close
+- Fixed ATCommand response getter
+- Added SyntaxError exception handler in ATScriptParser
+- Fixed value getter in ESK
+- Added Virtual Serial device
+- Test improvements
+
+## ATtila 1.0.4 (13/10/2019)
+
+- Added codecov
+- Added missing CR value in BREAK ESK
+- Added ESK and ATRE tests
+
+## ATtila 1.0.3 (12/10/2019)
+
+- Fixed help in main
+- Added Travis

CONTRIBUTING.md

@@ -1,15 +1,55 @@
 # Contributing
 
-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.
+- [Contributing](#contributing)
+ - [Preferred contributions](#preferred-contributions)
+ - [Pull Request Process](#pull-request-process)
+ - [Developer's guide](#developers-guide)
+ - [Tests Units](#tests-units)
+
+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](./README.md#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. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
-2. Update the README.md 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.
-3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
-4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.
+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](#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](docs/devwiki.md)
+
+## Tests Units
+
+ATtila is provided with tests units, which can be found under tests/ directory.
+To launch test unit just type:
+
+```sh
+nosetests -v --with-coverage --cover-tests --cover-package=attila --nocapture tests/
+```
+
+Don't you have nose?
+
+```sh
+sudo -H pip3 install nose coverage unittest2 codecov
+```
+
+---
 
-Thank you for any contribution! 
+Thank you for any contribution! 🧡  
 Christian Visintin