Commit 394556c9 authored by Sasha Goldshtein's avatar Sasha Goldshtein Committed by GitHub

Mention the smoke tests for new tool contributions

We probably have a couple of tools where we forgot about this already.
Make sure we don't forget again...
parent 58889898
...@@ -40,4 +40,5 @@ A checklist for bcc tool development: ...@@ -40,4 +40,5 @@ A checklist for bcc tool development:
1. **Read your man page**. For ROFF: nroff -man filename. Like before, this exercise is like saying something out loud. Does it sound too niche or convoluted? Again, hints that you might need to go back and fix things, or abandon it. 1. **Read your man page**. For ROFF: nroff -man filename. Like before, this exercise is like saying something out loud. Does it sound too niche or convoluted? Again, hints that you might need to go back and fix things, or abandon it.
1. **Spell check your documentation**. Use a spell checker like aspell to check your document quality before committing. 1. **Spell check your documentation**. Use a spell checker like aspell to check your document quality before committing.
1. **Add an entry to README.md**. 1. **Add an entry to README.md**.
1. **Add a smoke test** to [test_tools_smoke.py](https://github.com/iovisor/bcc/blob/master/tests/python/test_tools_smoke.py), which serves as a basic check that your tool still works when we make changes to the core library.
1. If you made it this far, pull request! 1. If you made it this far, pull request!
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment