splunk / splunk/addonfactory-solutions-library-python
Add Contributing Guidelines
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 18
- Fork
- 10
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
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
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
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.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- documentation, testing-qa
- Tipo di issue
- Documentazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 48/100