You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+17-16Lines changed: 17 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,23 +2,24 @@
2
2
3
3
First, thank you for contributing to OpenDAL! The goal of this document is to provide everything you need to start contributing to OpenDAL. The following TOC is sorted progressively, starting with the basics and expanding into more specifics.
4
4
5
-
-[Your First Contribution](#your-first-contribution)
6
-
-[Workflow](#workflow)
7
-
-[Git Branches](#git-branches)
8
-
-[GitHub Pull Requests](#github-pull-requests)
9
-
-[Title](#title)
10
-
-[Reviews & Approvals](#reviews--approvals)
11
-
-[Merge Style](#merge-style)
5
+
-[Contributing](#contributing)
6
+
-[Your First Contribution](#your-first-contribution)
7
+
-[Workflow](#workflow)
8
+
-[Git Branches](#git-branches)
9
+
-[GitHub Pull Requests](#github-pull-requests)
10
+
-[Title](#title)
11
+
-[Reviews \& Approvals](#reviews--approvals)
12
+
-[Merge Style](#merge-style)
12
13
-[CI](#ci)
13
-
-[Setup](#setup)
14
-
-[Using a dev container environment](#using-a-dev-container-environment)
15
-
-[Bring your own toolbox](#bring-your-own-toolbox)
16
-
-[Code of Conduct](#code-of-conduct)
14
+
-[Setup](#setup)
15
+
-[Using a dev container environment](#using-a-dev-container-environment)
16
+
-[Bring your own toolbox](#bring-your-own-toolbox)
17
+
-[Code of Conduct](#code-of-conduct)
17
18
18
19
## Your First Contribution
19
20
20
-
1. Ensure your change has an issue! Find an [existing issue](https://github.com/apache/incubator-opendal/issues) or [open a new issue](https://github.com/apache/incubator-opendal/issues/new).
21
-
1.[Fork the OpenDAL repository](https://github.com/apache/incubator-opendal/fork) in your own GitHub account.
21
+
1. Ensure your change has an issue! Find an [existing issue](https://github.com/apache/opendal/issues) or [open a new issue](https://github.com/apache/opendal/issues/new).
22
+
1.[Fork the OpenDAL repository](https://github.com/apache/opendal/fork) in your own GitHub account.
22
23
1.[Create a new Git branch](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository).
23
24
1. Make your changes.
24
25
1.[Submit the branch as a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) to the main OpenDAL repo. An OpenDAL team member should comment and/or review your pull request within a few days. Although, depending on the circumstances, it may take longer.
@@ -31,7 +32,7 @@ First, thank you for contributing to OpenDAL! The goal of this document is to pr
31
32
32
33
### GitHub Pull Requests
33
34
34
-
Once your changes are ready you must submit your branch as a [pull request](https://github.com/apache/incubator-opendal/pulls).
35
+
Once your changes are ready you must submit your branch as a [pull request](https://github.com/apache/opendal/pulls).
35
36
36
37
#### Title
37
38
@@ -56,7 +57,7 @@ All pull requests should be reviewed by at least one OpenDAL committer.
56
57
All pull requests are squash merged.
57
58
We generally discourage large pull requests that are over 300–500 lines of diff.
58
59
If you would like to propose a change that is larger, we suggest
59
-
coming onto our [Discussions](https://github.com/apache/incubator-opendal/discussions) and discussing it with us.
60
+
coming onto our [Discussions](https://github.com/apache/opendal/discussions) and discussing it with us.
60
61
This way we can talk through the solution and discuss if a change that large is even needed!
61
62
This will produce a quicker response to the change and likely produce code that aligns better with our process.
62
63
@@ -78,7 +79,7 @@ Please pick up your favourite runtime environment.
78
79
79
80
The fastest way is:
80
81
81
-
[](https://codespaces.new/apache/incubator-opendal?quickstart=1&machine=standardLinux32gb)
82
+
[](https://codespaces.new/apache/opendal?quickstart=1&machine=standardLinux32gb)
0 commit comments