Skip to content

Latest commit

 

History

History
34 lines (16 loc) · 2.85 KB

CONTRIBUTING.md

File metadata and controls

34 lines (16 loc) · 2.85 KB
Raw

Developer Guidelines

This is a discussion page to help the developers get started soon.

Documentation

  • Please make sure to document any user-facing changes on the respective module's README. If your change will affect how a user will use any of Niffler's modules, it should be reflected in the respective README.

  • In the code, please feel free to use logs. But do not use print() as they make the management of logs difficult. Rather, use the python logging module, and use the relevant log level. For example, if your log is merely a debug log, it should be logging.debug(). If it is a log that you expect to print always, you can use logging.info(), and for warnings and errors logging.warning() and logging.error() appropriately. While logs are helpful, too many logs will overwhelm the users and prevent them from extracting any useful information. As such, debug logs that you introduce to debug your coding, should be marked as logging.debug() rather than logging.info().

Commit logs

  • Please try to write meaningful commit messages.

Requests for Enhancement (RFE) and bugs

  • Have you got requests for enhancements or encountered a bug? Please open an issue in the bug tracker if it is not already reported there.

  • If you have questions and clarifications that are not bug reports, please use our Discussions forum.

Commits and pull requests

  • Please develop against the dev branch. New contributors are encouraged to submit pull requests, rather than directly committing even when you have committer access. Another developer can then review and merge your pull request.

  • The pull request should be minimal. Avoid including irrelevant changes in your pull request -- for example, unused library imports, line break changes, adding/removing new lines that interpret an unchanged code segment as changed. Inclusion of irrelevant changes in your pull request dilutes your actual contribution, and make it hard for the developers to merge and review. Please check with a "git diff" before committing your changes, to avoid such additions.

Community Outreach

Niffler has tremendously benefitted from open-source. We have been a part of the Google Summer of Code (GSoC), via the Department of Biomedical Informatics, Emory University as the mentoring organization. We have had two GSoC contributors in 2021 and another two in 2022. All of them have contributed to Niffler design and development and have become part of the Niffler developer community.

Please use the GitHub discussion forums for user-queries. For GSoC and similar open-source contributions, as well as for other real-time user queries, feel free to join the GSoC Emory BMI slack workspace using the link - http://bit.ly/emory-bmi and find the channel "niffler."