ashwath-vaithina-ibm commited on
Commit
e60400a
·
verified ·
1 Parent(s): 47e85e7

Delete CONTRIBUTING.md

Browse files
Files changed (1) hide show
  1. CONTRIBUTING.md +0 -84
CONTRIBUTING.md DELETED
@@ -1,84 +0,0 @@
1
- ## Contributing In General
2
- Our project welcomes external contributions. If you have an itch, please feel
3
- free to scratch it.
4
-
5
- To contribute code or documentation, please submit a **FIXME** [pull request](https://github.com/ibm/repo-template/pulls).
6
-
7
- A good way to familiarize yourself with the codebase and contribution process is
8
- to look for and tackle low-hanging fruit in the **FIXME** [issue tracker](https://github.com/ibm/repo-template/issues).
9
- Before embarking on a more ambitious contribution, please quickly [get in touch](#communication) with us.
10
-
11
- **Note: We appreciate your effort, and want to avoid a situation where a contribution
12
- requires extensive rework (by you or by us), sits in backlog for a long time, or
13
- cannot be accepted at all!**
14
-
15
- ### Proposing new features
16
-
17
- If you would like to implement a new feature, please **FIXME** [raise an issue](https://github.com/ibm/repo-template/issues)
18
- before sending a pull request so the feature can be discussed. This is to avoid
19
- you wasting your valuable time working on a feature that the project developers
20
- are not interested in accepting into the code base.
21
-
22
- ### Fixing bugs
23
-
24
- If you would like to fix a bug, please **FIXME** [raise an issue](https://github.com/ibm/repo-template/issues) before sending a
25
- pull request so it can be tracked.
26
-
27
- ### Merge approval
28
-
29
- The project maintainers use LGTM (Looks Good To Me) in comments on the code
30
- review to indicate acceptance. A change requires LGTMs from two of the
31
- maintainers of each component affected.
32
-
33
- For a list of the maintainers, see the [MAINTAINERS.md](MAINTAINERS.md) page.
34
-
35
- ## Legal
36
-
37
- Each source file must include a license header for the Apache
38
- Software License 2.0. Using the SPDX format is the simplest approach.
39
- e.g.
40
-
41
- ```
42
- /*
43
- Copyright <holder> All Rights Reserved.
44
-
45
- SPDX-License-Identifier: Apache-2.0
46
- */
47
- ```
48
-
49
- We have tried to make it as easy as possible to make contributions. This
50
- applies to how we handle the legal aspects of contribution. We use the
51
- same approach - the [Developer's Certificate of Origin 1.1 (DCO)](https://github.com/hyperledger/fabric/blob/master/docs/source/DCO1.1.txt) - that the Linux® Kernel [community](https://elinux.org/Developer_Certificate_Of_Origin)
52
- uses to manage code contributions.
53
-
54
- We simply ask that when submitting a patch for review, the developer
55
- must include a sign-off statement in the commit message.
56
-
57
- Here is an example Signed-off-by line, which indicates that the
58
- submitter accepts the DCO:
59
-
60
- ```
61
- Signed-off-by: John Doe <[email protected]>
62
- ```
63
-
64
- You can include this automatically when you commit a change to your
65
- local git repository using the following command:
66
-
67
- ```
68
- git commit -s
69
- ```
70
-
71
- ## Communication
72
- **FIXME** Please feel free to connect with us on our [Slack channel](link).
73
-
74
- ## Setup
75
- **FIXME** Please add any special setup instructions for your project to help the developer
76
- become productive quickly.
77
-
78
- ## Testing
79
- **FIXME** Please provide information that helps the developer test any changes they make
80
- before submitting.
81
-
82
- ## Coding style guidelines
83
- **FIXME** Optional, but recommended: please share any specific style guidelines you might
84
- have for your project.