Awesome

Community

• Community
  • About
  • Join the Community
    • Forums
      • Filecoin Community Forum
      • lotus Discussion Forum
      • Filecoin Proving Subsystem Discussion
    • Implementation Related Repo
    • Chat
    • GitHub issues
    • Security issues and disclosures
  • Useful links
  • Ecosystem Projects
    • Showcase Your Project!
    • Updates and Newsletter
    • Filecoin Shipyard
  • Events
    • Community calls
    • Filecoin Meetups
  • Contributing
    • Contributing Guidelines
  • Maintainers
  • License

About

Welcome to the Filecoin community repository! You can treat this repo as your go-to for all meta, non-code discussions in the Discussions Forum, documents used by multiple repositories (such as the Code of Conduct), and how to interact with the Filecoin project and other community members.

To get the latest network notifications, subscribe to status.filecoin.io.

If you are interested in discussing code or protocol design, feel free to come talk to us on our forums, chat channels, or in issues on our other Filecoin project repos.

Join the Community

> Note: Before posting to different communications channels, make sure to read the Code of Conduct.

The vast majority of the Filecoin Project conversations, including implementation, community support, ecosystem news, etc. take place on:

• Forums (mainly on Github Discussions)
• GitHub Issues (see Implementation related repo section below)
• Chat (mainly on Slack) (see Chat section below)

The Filecoin Project is an open sourced project with a very supportive and welcoming community, where many community members are responsive in various forums and slack channels. We also have Filecoin community ambassadors here to support you, tag their GitHub handlers in GitHub discussions or @fil-community-ambassadors in all slack channels if you have any questions!

Implementation dev teams tend to check their corresponding GitHub repo issues and discussions regularly and try to respond within 5 business days.

We also push updates to the community via:

• Forum - Network and implementations updates updates and news and events
• Filecoin blog: https://blog.filecoin.io
• CryptoComputeLab blog(proof updates): https://research.protocol.ai/groups/cryptocomputelab/
• Youtube: Filecoin
• Twitter: @Filecoin
• WeChat ID: Filecoin-Official

Forums

Filecoin Community Forum

When in doubt or curiosity, please post in Filecoin community forum!

We love to hear what the community has to say, whether it is to:

• Ask a question
• Gather community feedback on a new feature proposal before opening an FIP
• 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.

Note: A Chinese-language community forum is also available at https://github.com/filecoin-project/community-china/discussions. It is managed by CoinSummer.

lotus Discussion Forum

lotus discussion is an all-in-one place where you can track lotus releases and announcements, find tutorials ask questions about running a lotus node, lotus miner or lotus client, get help with troubleshooting, share your lotus setup or thoughts, chat with your fellow developers with how to build applications using lotus JsonRPC API and so on.

Filecoin Proving Subsystem Discussion

The Filecoin Proving Subsystem (or FPS) provides the storage proofs required by the Filecoin protocol. If you have any questions regarding the current proof, feedbacks for proof performance on different machines, ideas to improve proof or implementing new proof, join the forum here!

Implementation Related Repo

Chat

Vast majority of community live chat is happening in Filecoin Project Slack. Tag @fil-community-ambassadors if you have any questions!

Fun channels to join once you are in the workspace:

• #fil-announcements: This channel is for official Filecoin announcements only (including network, implementations, and ecosystem announcements). Join to get most up-to-date news. Please do not post questions or other messages here; they will be deleted!
• _fil-lobby: for general Filecoin-related sharing
• fil-help: ask questions here if you can't find another specific channel for your question
• fil-lotus: for lotus related discussion
• fil-fips: for Filecoin Improvement Proposals related discussion
• fil-plus: for Filecoin Plus(notary-governance) related discussion
• fil-net-calibration-discuss/fil-net-nerpa-discuss: for testnet disucssions
• fil-ecosystem-dev: for updates and discussion about building in the Filecoin ecosystem
• fil-deal-market: promote your miner as a storage provider or find your provider as a client here
• hackathons-help: join this channel if you are participating any Filecoin hackathons and have questions

Primary Slack channels are bridged (automatically mirrored and read-only) to Matrix.

GitHub issues

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:

• lotus (contribution guide)
• venus
• specs-actors
• rust-ffi-proofs
• specs

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!

Please refer to SECURITY.md document found in this repo on how to best report findings and participate on the bug bounty program.

Useful links

If you are new to the Filecoin Project, below are some helpful links for you to learn more about it:

• Official website: https://filecoin.io
• Filecoin Specification: contains documents, code, models, and diagrams that constitute the specification of the Filecoin Protocol.
• Filecoin Docs: offers all the necessary resources to learn about Filecoin, the software and the tools to contribute to the network, either as a user looking for storage, or as a miner providing it

Ecosystem Projects

If your project 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!

Showcase Your Project!

Following the steps below to submit your projects to be featured in 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 new discussion thread in this repository's Discussions > Project Showcase, titled [Category] Project Name(i.e: [Application] Slate). Add this link to the "How the community can engage" section. Use this thread to share your updates, and chat with users and potential users!
• 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 voila, your project is now featured here!

Updates and Newsletter

We'd encourage all projects featured in this repo to share all of your 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!

Events

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.

Community calls

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:

• Development Community Calls
• Mining Community Calls

We will announce each upcoming community call by making announcements in our chat channels and website.

Filecoin Meetups

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.

Click Attend a Filecoin virtual meetup for joining the next event!

Contributing

Contributing Guidelines

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.

Maintainers

Maintainers are responsible for maintaining the content of this repo, create an issue and tag one of the maintainers if you have any questions.

Current maintainers are: @jennijuju (jennijuju@protocol.ai)

License

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)