Welcome to the Filecoin community repository! You can treat this repo as your go-to for all meta, non-code discussions in the Discussions, documents used by multiple repositories (such as the Code of Conduct), and how to interact with the Filecoin project and other community members.
If you are interested in discussing code or protocol design, feel free to come talk to us on our discussion forums, chat channels, or in issues on our other Filecoin project repos.
The vast majority of the Filecoin Project conversations are held on:
- GitHub Issues
- Github Discussions
- The discussion forum
- Chat (on Matrix/Slack/IRC) (see Chat section below)
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:
- Filecoin blog: https://blog.filecoin.io
- Twitter: @Filecoin
- WeChat ID: Filecoin-Official
Before posting to different communications channels, make sure to read the Code of Conduct.
https://github.com/filecoin-project/community/discussions
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 (automatically copied) across Matrix, IRC, and Slack:
- Matrix: The Filecoin community on Element (our preferred Matrix client)
- Filecoin Project Slack: Create an account or login with your existing account at https://filecoin.io/slack
- 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!
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!
Please refer to SECURITY.md document found in this repo on how to best report findings and participate on the bug bounty program.
If your product uses Filecoin, you're in the Filecoin ecosystem! We'd love to see all awesome projects that are built on top of the Filecoin ecosystem to be known and get used by the Filecoin community!
Following the steps below to submit your projects to be featured in this this repo:
- Create a project profile using the Project submission template. Name the file name after your project and fill in as much information as you can. Use your project name as the file name so the community can find your project easily!
- Create a project discussion, with the category as Show and tell - Developers and title as
[Category] Project Name(i.e:[Application] Slate), link the discussion in the How the community can engage section. This is to create a place to interact with the Filecoin community, share your updates and gain feedback on your projects! - Once the project profile is ready, create a pr, prefix
[Project Submission]in the title, and request a review from one of the maintainers. - Let the maintainer know if you want your updates to be featured in Filecoin newsletter or not in the PR description!
- If everything looks good, the maintainer will merge the pr and wolala, as simple as that your project is now featured here!
We'd encourage all projects featured in this repo to share all thrilling updates with the community! Start a new comment with header Project Name Update/Newsletter - Date (i.e ## Slate Update - Feb, 2021) in your project discussion to share the exciting news with the community!
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 will be posted online at this repo.
Learn more about:
We will announce each upcoming community call by making announcements in our chat channels and website.
Filecoin meetups are a great way to meet and connect with other developers and miners in your community that are using and learning about Filecoin.
- Attend a Filecoin meetup (Coming soon)
- Organize a Filecoin meetup (Coming soon)
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 venus.
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!
Maintainers are responsible for maintaining the content of this repo, reviewing the issues and pull requests and moderate the discussion.
Current maintainers are: @jennijuju (jennifer.wang@protocol.ai)
The Filecoin Project is dual-licensed under Apache 2.0 and MIT terms:
- Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)