Community FAQ

Contents

Community FAQ#

This FAQ aims to answer common questions about the DeepSensor library. It is our way to streamline the onboarding process and clarify expectations.

Note

If you have a question you’d like to see answered here, make a request in a issue or in the Slack channel.

Questions#

Q: Why doesn’t the package name DeepSensor mention NPs if it’s all about neural processes?

Answer: DeepSensor aims to be extensible to models that are not necessarily NPs. We also wanted to keep the name short and easy to remember. The name DeepSensor is a reference to the fact that the library is about deep learning and sensor data.

Q: How can I contribute?

Answer: There are many ways to contribute, from writing code and fixing bugs to improving documentation or translating content. Check our Contributing to DeepSensor guide.

Q: Do I need to sign a Contributor License Agreement (CLA)?

Answer: At the current time, we do not require a CLA from our contributors.

Q: How do I report a bug?

Answer: Please submit an issue in our GitHub repository. Make sure to provide detailed information, including steps to reproduce the bug and the expected outcome.

Q: How do I request a new feature?

Answer: Open a new issue on our GitHub repository and label it as a feature request. Describe the feature in detail and its potential benefits.

Q: How can I get in touch with other contributors or maintainers?

Answer: Request to join our Slack channel to stay in touch with other contributors and maintainers. You can join by signing up for the Turing Environment & Sustainability stakeholder community. The form includes a question on signing up for the Slack team, where you can find DeepSensor’s channel.

We also have a regular community Zoom call (join the Slack channel or get in touch to find out more).

Q: How do I set up the development environment?

Answer: Follow the instructions in our developer documentation. If you run into issues, ask in our community chat (on Slack).

Q: Do you have a code of conduct?

Answer: Yes, we value a respectful and inclusive community. Please read our Code of Conduct before contributing.

Q: Can I contribute even if I’m not a coder?

Answer: Absolutely! Contributions can be made in the form of documentation, design, testing, and more. Everyone’s skills are valuable. Join our Slack discussion to learn more.

Q: How do I claim an issue to work on?

Answer: Comment on the issue expressing your interest to help out. If the issue is unassigned, a maintainer will likely assign it to you.

Q: What’s the process for proposing a significant change?

Answer: For significant changes, it’s a good practice to first open a discussion or issue to gather feedback. Once there’s a consensus, you can proceed with a pull request.

Q: How can I get my pull request (PR) merged?

Answer: Ensure your PR follows the contribution guidelines, passes all tests, and has been reviewed by at least one maintainer. Address any feedback provided.

Q: How is credit given to contributors?

Answer: Contributors are acknowledged via an all-contributors system, which records contributions (code or non-code) at the end of the project’s README. Code contributions are acknowledged in our release notes.

Contents