Skip to content

Latest commit

 

History

History
51 lines (37 loc) · 2.04 KB

CONTRIBUTING.md

File metadata and controls

51 lines (37 loc) · 2.04 KB
Raw

Contributing to Daksha

Thank you for taking the time to contribute! Please follow the following guidelines while contributing to this project.

General:

  • If it's a major feature/change please create an issue and discuss with project members.
  • Create a fork of Daksha on github (http://help.github.com/fork-a-repo/) and initiate a pull request to main branch for submitting your change/feature.

Python Code Quality Standards:

  • All code should compile and run for Python 3.8.
  • Maximum line length is 120 characters.
  • Indentation should be made with 4 spaces, not tabs.
  • For any non-trivial code, include comments.
  • Follow the logging conventions used in the rest of the project.
  • Tests should be included for any new functionality being added.

License

By contributing your code, you agree to license your contribution under the terms of the AGPLv3: LICENSE

All files are released with the AGPL v3 license.

If you are adding a new file it should have a header like this:

"""
Daksha
Copyright (C) 2021 myKaarma.
[email protected]
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

"""

Questions

If you have questions or want to report a bug please create an Issue