diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index b01e80e92..3b6343c4c 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -248,28 +248,6 @@ A PR can only be merged into main by a maintainer if: Any maintainer is allowed to merge a PR if all of these conditions are met. -Shipping a release (maintainers only) -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Maintainers need to do the following to push out a release: - -1. Switch to the main branch and make sure it's up to date. - -.. code:: shell - - $ git checkout main - $ git pull upstream main - -2. Tag the release with a version number and push it to GitHub. Note that the version number should follow `semantic versioning `_. e.g.: v0.1.0. - -.. code:: shell - - $ git tag -a v0.1.0 -m "GraphAr v0.1.0" - $ git push upstream v0.1.0 - -3. The release draft will be automatically built to GitHub by GitHub Actions. You can edit the release notes draft on `GitHub `_ to add more details. -4. Publish the release. - .. the reviewing part document is referred and derived from .. https://github.com/nodejs/node/blob/main/doc/contributing/pull-requests.md#the-process-of-making-changes diff --git a/README.md b/README.md index 5c0d93e9a..2d71d1389 100644 --- a/README.md +++ b/README.md @@ -262,7 +262,7 @@ we'd be happy to have you involved. Meeting](https://github.com/apache/incubator-graphar/wiki/GraphAr-Weekly-Community-Meeting). Read through our [community -introduction](https://github.com/apache/incubator-graphar/tree/main/docs/developers/community.rst) +introduction](https://graphar.apache.org/community/) to learn about our communication channels, governance, and more. # License diff --git a/dev/release-process.md b/dev/release-process.md deleted file mode 100644 index e0e2c6b08..000000000 --- a/dev/release-process.md +++ /dev/null @@ -1,19 +0,0 @@ -# Release Versioning & Process - -### GraphAr Version Number Scheme - -GraphAr releases are each assigned an incremental version number in the format `v..` base on the [Semantic Versioning](https://semver.org/). For example: - -- `v0.1.0` - New feature released. -- `v0.1.2` - Second patch release upon the `v0.1.0` feature release. - -Patch releases are generally fairly minor, primarily intended for fixes and therefore are fairly unlikely to cause breakages upon update. -Feature releases are generally larger, bringing new features in addition to fixes and enhancements. These releases have a greater chance of introducing breaking changes upon update, so it's worth checking for any notes in the [release notes](https://github.com/apache/incubator-graphar/releases). - -### Release Planning Process - -Each GraphAr release will have a [milestone](https://github.com/apache/incubator-graphar/milestones) created with issues & pull requests assigned to it to define what will be in that release. Milestones are built up then worked through until complete at which point, after some testing and documentation updates, the release will be deployed. - -### Release Announcements - -Feature releases, and some patch releases, will be accompanied by a release note on the [GitHub release page](https://github.com/apache/incubator-graphar/releases) which will provide additional detail on features, changes & updates. diff --git a/docs/developers/community.rst b/docs/developers/community.rst deleted file mode 100644 index 16f1c9729..000000000 --- a/docs/developers/community.rst +++ /dev/null @@ -1,71 +0,0 @@ -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 `graphar+subscribe@googlegroups.com `_ -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 `_ for our issue tracker and for source control. -See the `contribution guidelines `_ for more. - -.. _GraphAr Code of Conduct: https://github.com/apache/incubator-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/apache/incubator-graphar/wiki/Community-Meeting-Agenda diff --git a/docs/index.rst b/docs/index.rst index ef189d9d7..bb5bb8b68 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -37,4 +37,3 @@ Contributing Overview Java Development - Community