Support
We are happy to support you, answer questions, and help you use IPFS Cluster. You can reach out to the team and the community in several different ways:
- For general questions and usage guidance: we prefer that you open a topic at https://discuss.ipfs.io/.
- For bugs and feature requests: please open issues in the repository.
- For quick chat and questions: join the #ipfs-cluster channel on Matrix.
Interactions in all of these venues is governed by the IPFS Community Code of Conduct.
If you are looking for things to start with, filter for issues with easy and ready labels.
In general, anything marked with help wanted is ready to be taken on by external contributors.
Please let us know when you are going to work on something, or more clarifications are needed, so we can help you out!
Getting oriented
To check what’s going on in the project, check:
- the Changelog
- the News
- the Roadmap
- the upcoming release issues
Contribution Guidelines
IPFS Cluster adopts the existing guidelines in the IPFS community:
- The Go contribution guidelines
- The IPFS community contributing notes
- The IPFS Community Code of Conduct
Code contribution guidelines
In practice, these are our soft standards:
- IPFS Cluster uses the Apache2/MIT dual license.
- All contributions are via Pull Request, which needs a Code Review approval from one of the project collaborators.
- Tests must pass (although sometimes it takes several runs)
- Code coverage must be stable or increase
- We prefer meaningful branch names:
feat/999-adding-this,fix/392-error-doing-this… preferably with an issue number in them as well. - We prefer commit messages which reference an issue
fix #999: ...
These are just guidelines. We are friendly people and are happy to help :)
Do you use IPFS Cluster?
Let us know about your setup by contributing to the IPFS Cluster user registry.