diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 32c286f7e..ea3791e72 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,5 +7,5 @@ Have a look at [FACT’s Developer’s Manual](https://github.com/fkie-cad/FACT_ If you developed a plug-in, we would love to hear about it. We are going to provide a list of all available plug-ins. You are welcome to improve the FACT_core as well. -Please have a look at our [Coding Guidelines](https://fkie-cad.github.io/FACT_core/subsection/coding_guideline.html) before creating a pull request. +Please have a look at our [Coding Guidelines](https://github.com/fkie-cad/FACT_core/wiki/coding-guidelines) before creating a pull request. No matter how you would like to contribute: If you have any question, do not hesitate to ask. diff --git a/docs/index.md b/docs/index.md index 5df6ee590..a80758119 100644 --- a/docs/index.md +++ b/docs/index.md @@ -89,7 +89,7 @@ Have a look at [FACT’s Developer’s Manual](https://github.com/fkie-cad/FACT_ If you developed a plug-in, we would love to hear about it. We are going to provide a list of all available plug-ins. You are welcome to improve the FACT_core as well. -Please have a look at our [Coding Guidelines](subsection/coding_guideline.md) before creating a pull request. +Please have a look at our [Coding Guidelines](https://github.com/fkie-cad/FACT_core/wiki/coding-guidelines) before creating a pull request. No matter how you would like to contribute: If you have any question, do not hesitate to ask. # Authors and Acknowledgment diff --git a/docs/subsection/coding_guideline.md b/docs/subsection/coding_guideline.md deleted file mode 100644 index 78388d622..000000000 --- a/docs/subsection/coding_guideline.md +++ /dev/null @@ -1,18 +0,0 @@ -# Coding Guidelines - -* Do not use features above **Python 3.5** -* [PEP8](https://www.python.org/dev/peps/pep-0008/) code style shall be used. - * Exception: Lines may be as long as needed (--ignore=E501) -* We use pytest for testing. Please use the following pytest config: - -```python -[pytest] -addopts = --pep8 -v --cov=./ -pep8ignore = - *.py E501 -``` -* Test coverage should be as high as possible (at least 95%). -* Do not mix quotation: Use **'**single quotes**'** at all time. -* ```(__main__)``` programs must have a return value: use **sys.exit()** -* ```(__main__)``` programs shall provide *--version* (-v) and *--help* (-h) command line options: use **argparse** -* Dates should be formated according to ISO 8601: **YYYY-MM-DD**