aboutsummaryrefslogtreecommitdiffstats
path: root/tools/CONTRIBUTING.md
diff options
context:
space:
mode:
authoropensource-tnbt <sridhar.rao@spirent.com>2020-10-30 15:48:23 +0530
committeropensource-tnbt <sridhar.rao@spirent.com>2020-10-30 15:50:29 +0530
commit0fd1dc39ee6f6bb7f2c35f84c3a2a39d9e63805f (patch)
treef58b5d9ca603d193476254d3d5b13e853985ad64 /tools/CONTRIBUTING.md
parentdff7c66ee8e7ef0b8b14ad5776a1318b987d3eaa (diff)
CIRV-Cleanup: Remove HDV and SDV contents.
As CIRV-HDV and CIRV-SDV are active now, we do not need contents here. The docs folder has links to HDV and SDV. Signed-off-by: Sridhar K. N. Rao <sridhar.rao@spirent.com> Change-Id: I86ee90fb5e969e14d000d9a08d971b13a2c2740e
Diffstat (limited to 'tools/CONTRIBUTING.md')
-rw-r--r--tools/CONTRIBUTING.md70
1 files changed, 0 insertions, 70 deletions
diff --git a/tools/CONTRIBUTING.md b/tools/CONTRIBUTING.md
deleted file mode 100644
index 1aa6108..0000000
--- a/tools/CONTRIBUTING.md
+++ /dev/null
@@ -1,70 +0,0 @@
-<!---
-This work is licensed under a Creative Commons Attribution 4.0 International License.
-http://creativecommons.org/licenses/by/4.0
--->
-
-# General Coding Style
-
-## Code
-
-Abide by [PEP-8] for general code. Some particular points to note:
-
-* Wrap code at 79 characters.
-* Use only spaces - no tabs.
-* Use implicit string concatenation where possible. Don't use the escape
- character unless absolutely necessary.
-* Be liberal in your use of whitespace to group related statements together.
- However, don't leave a space after the docstring and the first statement.
-* Use single quotes for all string literals.
-
-## Documentation
-
-Follow [PEP-257] and the [Sphinx guidelines] for documentation. In particular:
-
-* Wrap docstrings at 72 characters.
-* Use double-quotes for all docstrings.
-* Write all inline comments in lower-case, except where using a name/initialism.
-* Document **all** library functions/classes completely. Tests, however, only need a test case docstring.
-
-To summarise the docstring conventions:
-
-```python
-def my_function(athing, stuff=5):
- """
- Summary line here in imperative tense.
-
- Longer description here...
-
- :param athing: Details about this paramter here
- :param stuff: Ditto
-
- :returns: None
- """
- pass # code here...
-```
-
-### Validation
-
-All code should be checked with the PyLint linter and PEP8 style guide checker.
-Pylint can be run like so:
-
-```bash
-pylint <file or directory>
-```
-
-Most PyLint errors should be resolved. You will need to do this manually.
-However, there are cases where they may not make sense (e.g. you **need** to
-pass `N` parameters to a function). In this case, disable the relevant
-case using an inline `disable` like so:
-
-```python
-# pylint: disable=[code]
-```
-
-On the other hand, all PEP8 errors should be resolved.
-
----
-
-[PEP-8]: http://legacy.python.org/dev/peps/pep-0008/
-[PEP-257]: http://legacy.python.org/dev/peps/pep-0257/
-[Sphinx guidelines]: https://pythonhosted.org/an_example_pypi_project/sphinx.html