docs: add committing style guide and fix typos (#244) #246
Conversation
|
@WaltherTrgovac I just recognized that you changed, e.g. |
|
I see what you mean, but .md and .py are two separate files, so the .md file stays unchanged. But if you want, I can revert the changes. Besides that, my idea was to make all the #ToDo comment sections and therefore .md files written in full sentences. And other comments I would leave as they are. |
That's totally correct. However, we used to have a parser to generate the *.md from *.py. Not sure if it still exists ;) |
|
I assumed that so I think it is better to leave them as it was, I will revert the changes. |
CONTRIBUTING.md
Outdated
|
|
||
| ## Unit-Tests | ||
| Espacially when creating new functions or classes, you have to add a unit-test function. | ||
| Especially when creating new functions or classes, you have to add a unit-test function. | ||
| Open the `test_module.py` file in the `\tests`-directory and add a function to the class `TestModule`with a name like `test_my_new_function`. If you create a new module, you have to create a new `test_my_new_module.py` file and follow the existing structure of the |
There was a problem hiding this comment.
This wording makes it sound like there's a test_module.py file already
chore: fix details Co-authored-by: Marwa Maghnie <[email protected]>
|
@Maghnie It looks good to me. You can merge if it also looks good for you now :) |
I have added the link for the committing style guide and fixed some typos.