title | permalink | excerpt | last_modified_at | redirect_from | sidebar | |||
---|---|---|---|---|---|---|---|---|
New feature checklist |
/docs/developer/new_feature_checklist/ |
New feature checklist |
2018-02-22 12:37:48 +0100 |
|
|
{% include toc %} {% include editme %}
The following are a set of guidelines for adding a new feature
- Add the feature to the code
- Ensure that the toolkit documentation is updated appropriately
- Create a sample demonstrating how to use the new feature
- Should be added to
samples
folder
- Should be added to
- Add a test case to ensure that the feature gets tested
- Add a topology-based test case to the
tests/MessageHubTests
project
- Add a topology-based test case to the
- Generate the SPLDoc, see HERE
- After pushing docs to
gh-pages
, verify that they are visible and correct when navigating to https://ibmstreams.github.io/streamsx.messagehub/.
- After pushing docs to