This is an automated email from the ASF dual-hosted git repository.
syfeng pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/tvm-ffi.git
The following commit(s) were added to refs/heads/dev by this push:
new 5facac5 [DOCS] Add Contributing (#9)
5facac5 is described below
commit 5facac5ff2881370ddcae7d9440849bc475b6ca7
Author: Tianqi Chen <[email protected]>
AuthorDate: Sun Sep 14 10:46:53 2025 -0400
[DOCS] Add Contributing (#9)
This PR adds contributing docs and also fixes remaining
places to point to the right location
---
CONTRIBUTING.md | 74 +++++++++++++++++++++++++++++++++++++++++++
README.md | 2 ++
docs/concepts/abi_overview.md | 4 +--
pyproject.toml | 6 ++--
4 files changed, 81 insertions(+), 5 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..d89796b
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,74 @@
+<!--- Licensed to the Apache Software Foundation (ASF) under one -->
+<!--- or more contributor license agreements. See the NOTICE file -->
+<!--- distributed with this work for additional information -->
+<!--- regarding copyright ownership. The ASF licenses this file -->
+<!--- to you under the Apache License, Version 2.0 (the -->
+<!--- "License"); you may not use this file except in compliance -->
+<!--- with the License. You may obtain a copy of the License at -->
+
+<!--- http://www.apache.org/licenses/LICENSE-2.0 -->
+
+<!--- Unless required by applicable law or agreed to in writing, -->
+<!--- software distributed under the License is distributed on an -->
+<!--- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -->
+<!--- KIND, either express or implied. See the License for the -->
+<!--- specific language governing permissions and limitations -->
+<!--- under the License. -->
+
+# Contributing to TVM FFI
+
+We welcome contributions of all kinds, including bug fixes, documentation
improvements, enhancements,
+and more. To ensure a smooth process, Here is a general guide to contributing.
+
+## Installation
+
+For development, you can install through editable installation:
+
+```bash
+git clone https://github.com/apache/tvm-ffi --recursive
+cd tvm-ffi
+pip install --no-build-isolation -e . -v
+```
+
+We recommend using the `--no-build-isolation` flag to ensure compatibility
with your existing environment.
+You can contribute to the repo through the following steps.
+
+- Fork the repository and create a new branch for your work.
+- Push your changes to your fork and open a pull request to the main
repository.
+ - Please provide a clear description of your changes and link to the
relevant issue if one exists.
+ - Create necessary test cases and documentation.
+- Work with the community by incorporating feedback from reviewers until the
change is ready to be merged.
+
+For significant changes, it's often a good idea to open a GitHub issue first
(with `[RFC] title`) to discuss your proposal.
+It is optional, but can be very helpful as it allows the maintainers and the
community to provide feedback and helps ensure your
+work aligns with the project's goals.
+
+
+## Stability and Minimalism
+
+C ABI stability is the top priority of this project. We also prioritize
minimalism and efficiency
+in the core so it is portable and can be used broadly.
+We also recognize potential needs for evolution to ensure it works best for
the machine
+learning systems community, and would like to work together collectively with
the community for such evolution.
+
+- When proposing a change, consider first whether things can be built on top
of the current mechanism.
+- We welcome RFCs and DISCUSS discussions for ABI discussions and rationales.
+- We will communicate very mindfully to the community about major changes.
+
+Feature improvements in the Python layer and C++ headers (that do not impact
the ABI) have
+comparatively less significant impacts on downstream users, so they can follow
normal contribution
+process in general open source projects.
+
+## Status and Release Versioning
+
+The project is in the RFC stage, which means the main features are complete.
+We anticipate the API will be reasonably stable but will continue to work with
the community to evolve it.
+More importantly, the RFC stage is a period where we are working with the open
source communities
+to ensure we evolve the ABI to meet the needs of frameworks.
+
+Releases during the RFC stage will be `0.X.Y`, where bumps in `X` indicate C
ABI-breaking changes
+and `Y` indicates other changes. We may also produce pre-releases (beta
releases) during this period.
+
+We anticipate the RFC stage will last for a few months, then we will start to
follow
+[Semantic
Versioning](https://packaging.python.org/en/latest/discussions/versioning/)
+(`major.minor.patch`) going forward.
diff --git a/README.md b/README.md
index 88083e9..525518e 100644
--- a/README.md
+++ b/README.md
@@ -18,3 +18,5 @@
# tvm ffi
[](https://github.com/apache/tvm-ffi/actions/workflows/ci_test.yml)
+
+
diff --git a/docs/concepts/abi_overview.md b/docs/concepts/abi_overview.md
index e891de6..ad671d3 100644
--- a/docs/concepts/abi_overview.md
+++ b/docs/concepts/abi_overview.md
@@ -29,8 +29,8 @@ so the code itself illustrates the low-level semantics of how
to work with the A
These can serve as references for how to build language bindings and compiler
codegen for the ABI.
```{note}
-The authoritative ABI specifications are defined in
[tvm/ffi/c_api.h](https://github.com/apache/tvm/blob/main/ffi/include/tvm/ffi/c_api.h)
for core ABI,
-and
[tvm/ffi/extra/c_env_api.h](https://github.com/apache/tvm/blob/main/ffi/include/tvm/ffi/extra/c_env_api.h)
for extra support features
+The authoritative ABI specifications are defined in
[tvm/ffi/c_api.h](https://github.com/apache/tvm-ffi/blob/main/include/tvm/ffi/c_api.h)
for core ABI,
+and
[tvm/ffi/extra/c_env_api.h](https://github.com/apache/tvm-ffi/blob/main/include/tvm/ffi/extra/c_env_api.h)
for extra support features
such as stream handling. This document provides explanations about design
concepts and rationales.
```
diff --git a/pyproject.toml b/pyproject.toml
index 4892161..bfe7b42 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -17,7 +17,7 @@
[project]
name = "apache-tvm-ffi"
-version = "0.1.0b0"
+version = "0.1.0b1"
description = "tvm ffi"
authors = [{ name = "TVM FFI team" }]
@@ -37,8 +37,8 @@ dependencies = []
[project.urls]
-Homepage = "https://github.com/apache/tvm/ffi";
-GitHub = "https://github.com/apache/tvm/ffi";
+Homepage = "https://github.com/apache/tvm-ffi";
+GitHub = "https://github.com/apache/tvm-ffi";
[project.optional-dependencies]
# setup tools is needed by torch jit for best perf
