Contributing and pep8 fixes #84
Conversation
| abspath(dirname(__file__)) + | ||
| "/interface_model1/model_b/app_error2.if") | ||
|
|
||
| ################################# | ||
| #####tests/functional/test_scoping/test_children.py############################ |
There was a problem hiding this comment.
Ah, yes, good catch :)
|
Very good! I will take my time to read and test your proposal. At first sight: Do we also need to include the flake command in the .travis.yml file? |
Yes, you are right, that is something I was up to do next. I'll need to investigate what is the best way to do it. |
|
I tested the contribution manual, and no errors occurred. |
|
Maybe we could also start to collect architectural entry points... Such as
Do you think something like doxygen could help to link architectural snippets to the code? You remember the explanation you gave me concerning 'containment' and 'reference' in PR #79. This could be valuable to other contributors. |
|
Thanks for testing. Merging. Regarding the dev docs, I agree. The overall architecture/processes description and main internal APIs would be helpful, not only for new contributors but for ourself as well as our brains are not the best places to keep all those stuff :) Although, I wouldn't go into too much of details (just the high-level overview) as the docs (especially dev docs) tend to become out-of-sync very fast. OTOH, I'm not that eager to introduce new documenting tools. The project is using mkdocs which is working really good and is very simple to use so IMHO we should use it for all docs parts. |
@goto40 This PR fixes numerous PEP-8 violations in the tests and brings a new contribution guide in the docs. This should help new contributors get started easier. Please review when you find time.
I'm planing to make flake8 adherence mandatory trough Travis CI.