ari/myt
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
myt/CONTRIBUTING.md
Ari Archer 54956dc851
Improved docs, fixed some bugs and improved issues 
- Improved ISSUE_TEMPLATE
- Added pylintrc
- Fixed contributing rules
- Fixed doc of myt module
- Added `--version` flag
- Split some functionality up in other scripts
- Added `doc.sh` for documentation generation
- Fixed some bugs in tox.ini
- Made git.sh to more permissive

Signed-off-by: Ari Archer <ari@mail.ari-web.xyz>
2022-02-01 18:25:39 +02:00

766 B
Raw Permalink Blame History

Contribution rules

  • Do not add any malicious code
  • Make sure your code passes at least all tests provided in scripts/test.sh
  • Make sure to run ./scripts/test.sh before contributing
  • If you add anything new please document it in doc/, the man page and/or the README.md
  • Make sure to update or add if necessary development dependencies in requirements.dev.txt and stuff that is 100% required in requirements.txt
  • If you need to add more tests to the test.sh script, but make sure to follow the same pattern of
log 'Doing something here'
do tests here
  • Make sure to commit using scripts/git.sh or at least rebuild the documentation using scripts/doc.sh
  • Make sure your new fix or feature works