Skip to content

Commit

Permalink
[MINOR][DOC] Add mail list to our communication tools and add communi…
Browse files Browse the repository at this point in the history
…ty introduction (#179)
  • Loading branch information
acezen authored May 31, 2023
1 parent f7083c7 commit e868e06
Show file tree
Hide file tree
Showing 4 changed files with 92 additions and 12 deletions.
28 changes: 18 additions & 10 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
GraphAr
========

|GraphAr CI| |Docs CI| |GraphAr Docs| |Discord|
|GraphAr CI| |Docs CI| |GraphAr Docs| |Good First Issue|

Welcome to GraphAr (short for "Graph Archive"), an open source, standardized file format for graph data storage and retrieval.

Expand Down Expand Up @@ -168,13 +168,19 @@ Code of Conduct

Help us keep GraphAr open and inclusive. Please read and follow our `Code of Conduct`_.

Community
---------
Getting Involved
----------------

Join the conversation and help the community.
Join the conversation and help the community. Even if you do not plan to contribute
to GraphAr itself or GraphAr integrations in other projects, we'd be happy to have you involved.

- `Discord`_
- `Weekly Community Meeting`_
- Join the mailing list: send an email to `[email protected] <mailto:[email protected]>`_.
Share your ideas and use cases for the project.
- Join the `GraphAr Slack`_ channel.
- Follow our activity on `GitHub issues <https://github.com/alibaba/GraphAr/issues>`_.
- Join our `Weekly Community Meeting`_.

Read through our `community introduction`_ to learn about our communication channels, governance, and more.


License
Expand All @@ -195,8 +201,8 @@ third-party libraries may not have the same license as GraphAr.
.. |GraphAr Docs| image:: https://img.shields.io/badge/docs-latest-brightgreen.svg
:target: https://alibaba.github.io/GraphAr/

.. |Discord| image:: https://img.shields.io/discord/1088377726634836051.svg?logo=discord&logoColor=fff&label=Discord&color=7389d8
:target: https://discord.gg/XPsfd4ShCu
.. |Good First Issue| image:: https://img.shields.io/github/labels/alibaba/GraphAr/Good%20First%20Issue?color=green&label=Contribute%20&style=plastic
:target: https://github.com/alibaba/GraphAr/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22

.. _GraphAr File Format: https://alibaba.github.io/GraphAr/user-guide/file-format.html

Expand All @@ -206,14 +212,16 @@ third-party libraries may not have the same license as GraphAr.

.. _example files: https://github.com/GraphScope/gar-test/blob/main/ldbc_sample/

.. _contribution guidelines: https://alibaba.github.io/GraphAr/user-guide/contributing.html
.. _contribution guidelines: https://github.com/alibaba/GraphAr/tree/main/CONTRIBUTING.rst

.. _Code of Conduct: https://github.com/alibaba/GraphAr/blob/main/CODE_OF_CONDUCT.md

.. _Discord: https://discord.gg/XPsfd4ShCu
.. _GraphAr Slack: https://join.slack.com/t/grapharworkspace/shared_invite/zt-1wh5vo828-yxs0MlXYBPBBNvjOGhL4kQ

.. _Weekly Community Meeting: https://github.com/alibaba/GraphAr/wiki/GraphAr-Weekly-Community-Meeting

.. _community introduction: https://github.com/alibaba/GraphAr/tree/main/docs/developers/community.rst

.. _GitHub Issues: https://github.com/alibaba/GraphAr/issues/new

.. _Github Discussions: https://github.com/alibaba/GraphAr/discussions
71 changes: 71 additions & 0 deletions docs/developers/community.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
GraphAr Community
====================

We welcome participation from everyone and encourage you to join us, ask questions, and get involved.

All participation in the GraphAr project is governed by the `GraphAr Code of Conduct`_.

Questions?
-----------

Mailing list
^^^^^^^^^^^^^
The `GraphAr mailing list`_ is for discussion of GraphAr development and usage.

Send an email to `[email protected] <mailto:[email protected]>`_
to subscribe to the mailing list.


Tag Convention
"""""""""""""""""
The mailing list follow the convention of prefixing subjects with one or more tags in order to
clarify the scope and purpose of messages. For example:

- [ANNOUNCE] GraphAr 0.1.0 released
- [DISCUSS][C++] How to implement a new API in C++?
- [DISCUSS][Format] How to support partition pruning?
- [Spark][Reader] Support the push-down of filters

When emailing to the mail list, please prefix the subject line with one or more tags.
Depending the topic of your email, tags may include one or more:

- Supported Environments: e.g., [C++], [Spark], [Java], etc.
- Specifications: e.g., [Format], [Reader], [Writer], [API], etc.

You may also prefix your subject line with [DISCUSS] if your email is intended to prompt a discussion
rather than get an answer to a specific question.

Slack
^^^^^^
If you are not used to communicate with mailing list, you can also join the
`GraphAr Slack`_ to chat with other GraphAr users and developers.

GitHub Issues
^^^^^^^^^^^^^
We use GitHub issues as a way to ask questions and engage with the GraphAr developer community
and for maintaining a queue of development work and as the public record of work on the project.
We use the mailing list for development discussions, where a lengthy discussions is required.

Community Meeting
^^^^^^^^^^^^^^^^^
We host online meetings to provide spaces for synchronous discussions about the GraphAr project.
These discussions usually focus on topics of interest to developers who are contributing to GraphAr,
but we welcome users of GraphAr to join.

The community meeting runs weekly, every Tuesday at 7:00 PM (UTC+8). The meeting is hosted on Ali Meeting.

See the `community meeting notes`_ for the next meeting.


Contributing
------------
As mentioned above, we use `GitHub <https://github.com/alibaba/GraphAr>`_ for our issue tracker and for source control.
See the `contribution guidelines <https://github.com/alibaba/GraphAr/tree/main/CONTRIBUTING.rst>`_ for more.

.. _GraphAr Code of Conduct: https://github.com/alibaba/GraphAr/blob/main/CODE_OF_CONDUCT.md

.. _GraphAr mailing list: https://groups.google.com/g/graphar

.. _GraphAr Slack: https://join.slack.com/t/grapharworkspace/shared_invite/zt-1wh5vo828-yxs0MlXYBPBBNvjOGhL4kQ

.. _community meeting notes: https://github.com/alibaba/GraphAr/wiki/Community-Meeting-Agenda
File renamed without changes.
5 changes: 3 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,11 @@

.. toctree::
:maxdepth: 1
:caption: Contribution Guide
:caption: Development
:hidden:

user-guide/contributing.rst
developers/community.rst
developers/contributing.rst

.. toctree::
:maxdepth: 1
Expand Down

0 comments on commit e868e06

Please sign in to comment.