Skip to content

Commit 6d4e0e2

Browse files
committed
Update readme
1 parent d04c696 commit 6d4e0e2

File tree

1 file changed

+64
-48
lines changed

1 file changed

+64
-48
lines changed

README.md

Lines changed: 64 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,90 +1,98 @@
11
# Community
22

3-
## Table of Contents
4-
5-
- [Community](#community)
6-
- [Table of Contents](#table-of-contents)
7-
- [About](#about)
8-
- [Discuss](#discuss)
9-
- [Community forum](#community-forum)
10-
- [Chat](#chat)
11-
- [GitHub issues](#github-issues)
12-
- [Security issues and disclosures](#security-issues-and-disclosures)
13-
- [Ecosystem Projects](#ecosystem-projects)
14-
- [Showcase Your Project!](#showcase-your-project)
15-
- [Updates and Newsletter](#updates-and-newsletter)
16-
- [Events](#events)
17-
- [Community calls](#community-calls)
18-
- [Filecoin Meetups](#filecoin-meetups)
19-
- [Contributing](#contributing)
20-
- [Contributing Guidelines](#contributing-guidelines)
21-
- [Filecoin Shipyard](#filecoin-shipyard)
22-
- [Maintainers](#maintainers)
23-
- [License](#license)
3+
<!-- TOC -->autoauto- [Community](#community)auto - [About](#about)auto - [Join the Community](#join-the-community)auto - [Forums](#forums)auto - [Filecoin Community Forum](#filecoin-community-forum)auto - [lotus Discussion](#lotus-discussion)auto - [Filecoin Proving Subsystem Discussion](#filecoin-proving-subsystem-discussion)auto - [Implementation Related Repo](#implementation-related-repo)auto - [Chat](#chat)auto - [GitHub issues](#github-issues)auto - [Security issues and disclosures](#security-issues-and-disclosures)auto - [Useful links](#useful-links)auto - [Ecosystem Projects](#ecosystem-projects)auto - [Showcase Your Project!](#showcase-your-project)auto - [Updates and Newsletter](#updates-and-newsletter)auto - [Filecoin Shipyard](#filecoin-shipyard)auto - [Events](#events)auto - [Community calls](#community-calls)auto - [Filecoin Meetups](#filecoin-meetups)auto - [Contributing](#contributing)auto - [Contributing Guidelines](#contributing-guidelines)auto - [Maintainers](#maintainers)auto - [License](#license)autoauto<!-- /TOC -->
244

255
## About
266

27-
Welcome to the Filecoin community repository! You can treat this repo as your go-to for all meta, non-code discussions in the [*Discussions*](https://github.com/filecoin-project/community/discussions), documents used by multiple repositories (such as the Code of Conduct), and how to interact with the Filecoin project and other community members.
7+
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*](https://github.com/filecoin-project/community/discussions), documents used by multiple repositories (such as the Code of Conduct), and how to interact with the Filecoin project and other community members.
288

29-
If you are interested in discussing code or protocol design, feel free to come talk to us on our [discussion forums](#community-forum), [chat channels](#chat), or in issues on our other [Filecoin project repos](https://github.com/filecoin-project).
9+
To get the latest network notifications, subscribe to [status.filecoin.io](https://status.filecoin.io).
3010

31-
## Discuss
11+
If you are interested in discussing code or protocol design, feel free to come talk to us on our [forums](#forums), [chat channels](#chat), or in issues on our other [Filecoin project repos](https://github.com/filecoin-project).
3212

33-
The vast majority of the Filecoin Project conversations are held on:
13+
## Join the Community
3414

35-
- GitHub Issues
36-
- Github Discussions
37-
- [The discussion forum](https://discuss.filecoin.io)
38-
- Chat (on Matrix/Slack/IRC) (see [Chat](#chat) section below)
15+
**> Note: Before posting to different communications channels, make sure to read the [Code of Conduct](https://github.com/filecoin-project/community/blob/master/CODE_OF_CONDUCT.md).**
3916

40-
We tend to be pretty responsive during normal business hours, which vary according to our timezones (we have a fully distributed team).
17+
The vast majority of the Filecoin Project conversations, including implementation, community support, ecosystem new and etc, are held on:
18+
19+
- [Forums](#forums) (mainly on Github Discussions)
20+
- GitHub Issues (see [Implementation related repo](#impelmentation-related-repo) section below)
21+
- Chat (mainly on Slack) (see [Chat](#chat) section below)
22+
23+
The Filecoin Project is an open sourced project with a very supportive and welcoming community, where many community members are responsive in various of forums and slack channels. We also have [Filecoin community ambassadors](https://github.com/filecoin-project/community/discussions/116#discussioncomment-617066) here to support you, tag their GitHub handlers in GitHub discussions or @fil-community-ambassadors in all slack channels if you have any questions!
24+
25+
Implementation dev teams tend to check their corresponding GitHub repo issues and discussions regularly and try to respond within 5 business days.
4126

4227
We also push updates to the community via:
4328

29+
- Forum - [`Network and implementations updates`](https://github.com/filecoin-project/community/discussions/categories/network-and-implementations-updates) updates and [`news and events`](https://github.com/filecoin-project/community/discussions/categories/news-and-events)
4430
- Filecoin blog: [https://blog.filecoin.io](https://blog.filecoin.io)
31+
- CryptoComputeLab blog(proof updates): [https://research.protocol.ai/groups/cryptocomputelab/](https://research.protocol.ai/groups/cryptocomputelab/)
32+
- Youtube: [Filecoin](https://www.youtube.com/channel/UCPyYmtJYQwxM-EUyRUTp5DA)
4533
- Twitter: [@Filecoin](https://twitter.com/Filecoin)
4634
- WeChat ID: Filecoin-Official
4735

4836
![filecoin qr code](/images/qrcode_for_gh_da36751a6108_1280.jpg)
4937

50-
Before posting to different communications channels, make sure to read the [Code of Conduct](https://github.com/filecoin-project/community/blob/master/CODE_OF_CONDUCT.md).
5138

52-
### Community forum
39+
### Forums
5340

54-
[https://github.com/filecoin-project/community/discussions](https://github.com/filecoin-project/community/discussions)
41+
#### Filecoin Community Forum
5542

56-
When in doubt, please post here!
43+
When in doubt or curiosity, please post in Filecoin community forum](https://github.com/filecoin-project/community/discussions) !
5744

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

6047
- Ask a question
61-
- Propose a new feature
48+
- Gathering community feedbacks on a new feature proposal before open an FIP
6249
- Share a new project you're working on
6350
- Find collaborators for your own community project
6451
- And whatever else! Honestly!
6552

6653
The discussion forum uses the same Code of Conduct as our other community channels. Please make sure to read this before posting.
6754

55+
> Note: Chinese community forum is available [here](https://github.com/filecoin-project/community-china/discussions), which is managed by [CoinSummer](https://github.com/CoinSummer).
56+
57+
#### lotus Discussion
58+
59+
[lotus discussion](https://github.com/filecoin-project/lotus/discussions) is an all-in-one place where you can track [lotus releases and announcements](https://github.com/filecoin-project/lotus/discussions/categories/announcement), find [tutorials](https://github.com/filecoin-project/lotus/discussions/categories/tutorials) ask questions about running[ a lotus node](https://github.com/filecoin-project/lotus/discussions/categories/syncing), [lotus miner ](https://github.com/filecoin-project/lotus/discussions/categories/miner-q-a)or lotus client, get help with troubleshooting, [share your lotus setup or thoughts](https://github.com/filecoin-project/lotus/discussions/categories/show-and-tell), chat with your fellow developers with [how to build ](https://github.com/filecoin-project/lotus/discussions/categories/developer-q-a)applications using lotus JsonRPC API and so on.
60+
61+
62+
#### Filecoin Proving Subsystem Discussion
63+
64+
The Filecoin Proving Subsystem (or FPS) provides the storage proofs required by the Filecoin protocol. If you have any question regard to the current proof, feedbacks for proof performance on different machines, ideas to improve proof or implementing new proof, join the [forum here](https://github.com/filecoin-project/rust-fil-proofs/discussions)!
65+
66+
### Implementation Related Repo
67+
6868
### Chat
6969

70-
You can join the conversation on chat via Matrix, IRC, and Slack.
70+
Vast majority of community live chat is happening in [Filecoin Project Slack](https://filecoin.io/slack). Tag @fil-community-ambassadors if you have any questions!
71+
72+
Fun channels to join once you are in the workspace:
7173

72-
Our primary chat channels are bridged (automatically copied) across Matrix, IRC, and Slack:
74+
- `#fil-announcement`: This channel is for official Filecoin announcements only(including network, implementations and ecosystem announcements). Subscribe to get most up-to-date news, however, please do not post questions or other messages here!
75+
- `_fil-lobby`: for general Filecoin related sharing mostly
76+
- `fil-help`: ask questions here if you can't find another specific channel for your question
77+
- `fil-lotus`: for lotus related discussion
78+
- `fil-fips`: for [Filecoin Improvement Proposals](https://github.com/filecoin-project/FIPs) related discussion
79+
- `fil-plus`: for Filecoin Plus([notary-governance](https://github.com/filecoin-project/notary-governance)) related discussion
80+
- `fil-net-calibration-discuss`/`fil-net-nerpa-discuss`: for testnet disucssions
81+
- `fil-ecosystem-dev`: for Filecoin ecosystem projects updates and development chats
82+
- `fil-deal-market`: promote your miner as a storage provider or find your provider as a client here
83+
- `hackathon-help`: join this channel if you are participating any Filecoin hackathon and have questions
7384

74-
- **Matrix:** The [Filecoin community](https://app.element.io/#/group/+filecoin:matrix.org) on Element (our preferred Matrix client)
75-
- **Filecoin Project Slack:** Create an account or login with your existing account at [https://filecoin.io/slack](https://filecoin.io/slack)
76-
- **IRC:** [Coming soon](https://github.com/filecoin-project/community/issues/4)
85+
Primary Slack channels are bridged (automatically mirrored and read-only) to [Matrix](https://app.element.io/#/group/+filecoin:matrix.org).
7786

78-
Note that you can generally think of the above options as interchangeable. Note, however, that some channels may not be bridged across chat spaces.
7987

8088
### GitHub issues
8189

8290
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:
8391

84-
- [`lotus`](https://github.com/filecoin-project/lotus/issues)
92+
- [`lotus`](https://github.com/filecoin-project/lotus/issues) ([contribution guide](https://github.com/filecoin-project/lotus#contribute))
8593
- [`venus`](https://github.com/filecoin-project/venus/issues)
8694
- [`specs-actors`](https://github.com/filecoin-project/specs-actors/issues)
87-
- [`rust-proofs`](https://github.com/filecoin-project/rust-proofs/issues)
95+
- [`rust-ffi-proofs`](https://github.com/filecoin-project/rust-fil-proofs)
8896
- [`specs`](https://github.com/filecoin-project/specs/issues)
8997

9098
If a repo has a Contributing Guide, please read it before filing an issue!
@@ -95,6 +103,13 @@ Almost anything you find that is a bug in the codebase should be filed as an iss
95103

96104
Please refer to [SECURITY.md](./SECURITY.md) document found in this repo on how to best report findings and participate on the bug bounty program.
97105

106+
## Useful links
107+
108+
If you are new to the Filecoin Project, below are some helpful links for you to learn more about it:
109+
- Official website: [https://filecoin.io](https://filecoin.io)
110+
- [Filecoin Specification](https://spec.filecoin.io): contains documents, code, models, and diagrams that constitute the specification of the Filecoin Protocol.
111+
- [Filecoin Docs](https://docs.filecoin.io): 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
112+
98113
## Ecosystem Projects
99114

100115
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!
@@ -112,6 +127,11 @@ Following the steps below to submit your projects to be featured in this this [r
112127

113128
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!
114129

130+
### Filecoin Shipyard
131+
132+
[Filecoin Shipyard](https://github.com/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!
133+
134+
115135
## Events
116136

117137
Add our [Google Calendar](https://calendar.google.com/calendar/b/6?cid=ZmlsZWNvaW4ub3JnX2o3bW1ldjI0ZzgwcmVsbzU2cHFtMWVsMWUwQGdyb3VwLmNhbGVuZGFyLmdvb2dsZS5jb20) or follow issues in this repo to keep track of events (meetups, hackathons, etc.) hosted by the Filecoin Project and/or Protocol Labs.
@@ -149,13 +169,9 @@ We use a common [Code of Conduct](https://github.com/filecoin-project/community/
149169

150170
Each repo should have its own contributing guide, called `CONTRIBUTING.md`. Here is an example [Contributing Guide for `venus`](https://github.com/filecoin-project/venus/blob/master/CONTRIBUTING.md).
151171

152-
### Filecoin Shipyard
153-
154-
[Filecoin Shipyard](https://github.com/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!
155-
156172
## Maintainers
157173

158-
Maintainers are responsible for maintaining the content of this repo, reviewing the issues and pull requests and moderate the [discussion](https://github.com/filecoin-project/community/discussions).
174+
Maintainers are responsible for maintaining the content of this repo, create an issue and tag one of the maintainers if you have any questions.
159175

160176
Current maintainers are:
161177

0 commit comments

Comments
 (0)