Add Contributing Guidelines
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 48/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation, testing-qa
Research direction
Start with the README and the contributing documentation examples linked in the issue, then inspect tests/integration and tests/integration/data/solnlib_demo. Document the prerequisites and listed environment, copy, authentication, and restart commands for running integration tests. Done means a newcomer can set up the environment and follow the documented test process.
Written by the indexing model from the issue text.
Description
This is not obvious for someone who wants to contribute how to setup properly dev environment and run tests.
New section in documentation would help.
Example for that:
- https://github.com/splunk/addonfactory-ucc-generator/blob/main/README.md?plain=1
- https://github.com/splunk/addonfactory-ucc-generator/blob/main/docs/contributing.md?plain=1
It seems that the documentation should contain information about following prereq steps to run integration tests:
export SPLUNK_HOME=/opt/splunk/export SPLUNK_ETC=/opt/splunk/etc/- this one may be optionalsudo cp -r tests/integration/data/solnlib_demo $SPLUNK_HOME/etc/appssudo cp -r solnlib $SPLUNK_HOME/etc/apps/solnlib_demo/bin/sudo /opt/splunk/bin/splunk set servername custom-servername -auth admin:[splunk_password]sudo /opt/splunk/bin/splunk restart
- Dominant language
- Python
- Stars
- 18
- Forks
- 10
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from splunk/addonfactory-solutions-library-python
-
bug
Difficulty 5/5 Over a week Newbie friendliness 30/100
-
splunk/addonfactory-solutions-library-python#420 · 4 comments · 1 assignee ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
splunk/addonfactory-solutions-library-python#334 · 6 comments ·
-
bug
splunk/addonfactory-solutions-library-python#311 · 2 comments · 1 assignee ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 48/100
All issues in splunk/addonfactory-solutions-library-python
Similar issues
-
agent-ready documentation needs-triage
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
-
documentation
Difficulty 1/5 Under an hour Newbie friendliness 91/100
-
workflow-status page template still says reusable workflows are "triggered only by workflow_call:" Open
Difficulty 1/5 Under an hour Newbie friendliness 92/100
-
instance instance add
Difficulty 1/5 Under an hour Newbie friendliness 72/100
searxng/searx-instances#939 · 1 comment ·
-
area-deployment area-integrations triage:bot-seen
Difficulty 2/5 Half a day Newbie friendliness 86/100