Contributing

We are happy whenever you decide to contribute to DL_Track_US. However, when contributing to DL_Track_US, please first file an issue in our Github issue section. Label the issue with “improvement” and describe your suggestion. Please formulate the title of the issue similar to this: Contribution - Your contribution idea. Please also state in the issue wheter you want to implement it yourself / already implemented it in your code or if you would like us to implement it. We will be in touch with you. Please note we have a code of conduct, please follow it in all your interactions with the project.

In case you have decided to implement your suggestion yourself and we agreed that you should file a pull request, take a look at the steps listed below.

Pull Request Process for contributing own material

Update the DL_Track_US_tutorial.pdf in the docs folder with details of changes to the interface should they be relevant for the user. Simply add the step where it is during the analysis or create a new chapter.
Add a changelog to the changelog.d folder describing exactly what you changed in the project and the environment.
When adding new functions, please follow the code and docstring styles used throughout the code. FYI, we used the Numpy styleguide.
Create a new branch (named yourchange_yourinitials) and a Pull Request to merge your work on the main branch of the project.

Report a bug

In order to report a bug, please file an issue in our issue section on Github. Label your issue with the “bug” label and describe the bug you found. Please formulate the title of the issue similar to this: Bugreport - Your bug that occured. Please describe the occurence of the bug as reproducible as possible. It’s best to share with us the following in the issue:

operating system
the error raised by your code
all steps to reproduce the bug
code that produced the bug

We will then be in touch with you and try to solve the problem as quickly as possible. Please note we have a code of conduct, please follow it in all your interactions with the project.

Getting Support

If you have any questions about the project, encountered problems / need help during the installation procedure or encountered problems / need help during the usage of DL_Track_US_US not related to bugs, don’t hesitate to report this in the Q&A section in the DL_Track_US discussion forum. This is the space to have conversations, ask questions and post answers without opening issues.

Code of Conduct

Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.

Our Standards

Examples of behavior that contributes to creating a positive environment include:

Using welcoming and inclusive language
Being respectful of differing viewpoints and experiences
Gracefully accepting constructive criticism
Focusing on what is best for the community
Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

The use of sexualized language or imagery and unwelcome sexual attention or advances
Trolling, insulting/derogatory comments, and personal or political attacks
Public or private harassment
Publishing others’ private information, such as a physical or electronic address, without explicit permission
Other conduct which could reasonably be considered inappropriate in a professional setting

Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

Scope

This Code of Conduct applies within all project spaces, and it also applies when an individual is representing the project or its community in public spaces. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [paul.ritsche@unibas.ch]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project’s leadership.

Attribution

This Code of Conduct is adapted from the Contributor Covenant homepage, version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html. For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq.