Skip to content

Commit 68003fe

Browse files
committed
docs: replace CONTRIBUTING.md with community guide link
Remove the detailed contributing instructions and replace the file content with a reference link to the centralized community contributors' guide for consistency and easier maintenance. Signed-off-by: Peng Tao <[email protected]>
1 parent 2af3123 commit 68003fe

File tree

1 file changed

+1
-59
lines changed

1 file changed

+1
-59
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,3 @@
11
# Contributors' Guide
22

3-
## Getting started
4-
5-
Welcome to the Cloud Native AI Model Format Specification project! We are excited to have you contribute. Here are some steps to help you get started.
6-
7-
## Setting up your local environment
8-
9-
* **Clone the repository**:
10-
11-
```sh
12-
git clone https://github.com/modelpack/model-spec.git
13-
cd model-spec
14-
```
15-
16-
* **Install dependencies**: Ensure you have [Go](https://go.dev/) installed, as the current spec implementation is written in Go. Follow the [official instructions to install Go](https://go.dev/doc/install).
17-
18-
## Where to put changes
19-
20-
Right now, we have a simple directory structure:
21-
22-
* `docs`: All detailed documents about the model spec.
23-
* `docs/img`: Any referenced images in the documents should be put here.
24-
* `specs-go`: A Go implementation of the model specification.
25-
26-
## Raise a pull request
27-
28-
* **Create a new branch**:
29-
30-
```sh
31-
git checkout -b your-branch-name
32-
```
33-
34-
* **Make your changes and commit them**:
35-
36-
```sh
37-
git add .
38-
git commit -s -m "Your descriptive commit message"
39-
```
40-
41-
* **Push your changes to your fork**:
42-
43-
```sh
44-
git push your-fork-repo your-branch-name
45-
```
46-
47-
* **Open a pull request**: Go to the GitHub repository, compare your branch, and submit a pull request with a detailed description of your changes.
48-
49-
## Make sure pull request CI passes
50-
51-
Please check the CI status in your pull request and fix anything that fails. Here are some simple instructions to validate CI locally.
52-
53-
* **Install golangci-lint**: follow the [official installation guide](https://golangci-lint.run/welcome/install/#local-installation) to install golangci-lint.
54-
55-
* **Check for linting issues**:
56-
57-
```sh
58-
golangci-lint run --verbose
59-
```
60-
61-
We appreciate your contributions and look forward to working with you!
3+
Please refer to the project's [community contributors' guide](https://github.com/modelpack/community/blob/main/CONTRIBUTING.md) for guidelines on how to contribute to the project.

0 commit comments

Comments
 (0)