Table of Contents
Welcome to the Filecoin community repository! You can treat this repo as your go-to for all meta, non-code discussions (in the issues), documents used by multiple repositories (such as the Code of Conduct), and how to interact with the Filecoin project and other community members.
The vast majority of the Filecoin Project conversations are held on:
We tend to be pretty responsive during normal business hours, which vary according to our timezones (we have a fully distributed team).
We also push updates to the community via:
Before posting to different communications channels, make sure to read the Code of Conduct.
When in doubt, please post here!
We love to hear what the community has to say, whether it is to:
- Ask a question
- Propose a new feature
- Share a new project you're working on
- Find collaborators for your own community project
- And whatever else! Honestly!
The discussion forum uses the same Code of Conduct as our other community channels. Please make sure to read this before posting.
You can join the conversation on chat via Matrix, IRC, and Slack.
Our primary chat channels are bridged across Matrix, IRC, and Slack:
- Matrix: The Filecoin community on Riot (our preferred Matrix client)
- Filecoin Project Slack: Create an account here or visit https://filecoinproject.slack.com if you already have an account
- IRC: Coming soon
Note that you can generally think of the above options as interchangeable. Note, however, that some channels may not be bridged across chat spaces.
If you find something puzzling or encounter a straight-up bug in any of our repositories, please file a well-scoped issue. The issue lists for our most active repositories are below:
If a repo has a Contributing Guide, please read it before filing an issue!
Security issues and disclosures
Almost anything you find that is a bug in the codebase should be filed as an issue. The exception is if you find a security vulnerability. The Filecoin protocol is still under heavy development. This means that there may be problems in our protocol design or implementations. Though Filecoin is not yet production-ready, many people are already running nodes on their machines. So we take security vulnerabilities very seriously! If you discover a security issue, please bring it to our attention right away!
If you find a security vulnerability, please send your report privately to email@example.com - if so inclined, please use our GPG key to encrypt sensitive information. Alternatively, please request to join the filecoin-sec team on Keybase, where we can set up a private channel to discuss. Please DO NOT file a public issue.
If the issue is a protocol weakness that cannot be immediately exploited or has not yet been deployed, just discuss it openly.
Add our Google Calendar or follow issues in this repo to keep track of events (meetups, hackathons, etc.) hosted by the Filecoin Project and/or Protocol Labs.
Our community calls are venues for all Filecoin Project community members to meet each other, share demos of recent work, discuss open problems, and more. We expect these calls to be extremely respectful venues where all community members follow our Code of Conduct and treat each other (i) as they would like to be treated and (ii) as they would treat each other in real life.
All community calls are open for anyone to join. However, we recommend that you take a look at each call's agenda (which can be found on GitHub issues under the label
agenda) to make sure the call will be a good use of your time. We do our best to group similar demos and other agenda items together in the same call so it is easier to choose calls that you would like to attend.
Furthermore, we hold different calls for different communities. If you are a third-party app developer or OSS contributor, you might be interested in attending our monthly development community calls that are geared towards topics that developers will find useful. We also hold occasional mining community calls that are geared towards the needs of Filecoin miners.
Feel free to attend whichever calls are interesting to you. All calls are recorded, and the recording and notes will be posted online at this repo.
Learn more about:
We use a common Code of Conduct across all of our repos.
Each repo should have its own contributing guide, called
CONTRIBUTING.md. Here is an example Contributing Guide for
Filecoin Shipyard is a home we created for projects built by the Filecoin community. We encourage you to take a look around to explore some early projects incubated by the Filecoin community! If you're building something new on top of Filecoin, feel free to request to to add your project to the Shipyard!
The Filecoin Project is dual-licensed under Apache 2.0 and MIT terms: