Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Fix broken links, contributing guidelines, and enable communication with the Maintainers and Committers of the project.
  • Loading branch information
kdrodger committed Jul 24, 2019
1 parent 900ccfb commit 7fc8eb2
Showing 1 changed file with 16 additions and 47 deletions.
63 changes: 16 additions & 47 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,30 @@
## Contributing In General
Our project welcomes external contributions. If you have an itch, please feel
free to scratch it.

To contribute code or documentation, please submit a **FIXME** [pull request](https://github.com/ibm/repo-template/pulls).
Our project welcomes external contributions. If you have an itch, please feel free to scratch it.

A good way to familiarize yourself with the codebase and contribution process is
to look for and tackle low-hanging fruit in the **FIXME** [issue tracker](https://github.com/ibm/repo-template/issues).
Before embarking on a more ambitious contribution, please quickly [get in touch](#communication) with us.
To contribute code or documentation, please submit a [pull request](https://github.com/IBM/db2-samples/pulls).

**Note: We appreciate your effort, and want to avoid a situation where a contribution
requires extensive rework (by you or by us), sits in backlog for a long time, or
cannot be accepted at all!**
A good way to familiarize yourself with the codebase and contribution process is to look for and tackle low-hanging fruit in the [issue tracker](https://github.com/IBM/db2-samples/issues). Before embarking on a more ambitious contribution, please quickly [get in touch](#communication) with us.

### Proposing new features
**Note: We appreciate your effort, and simply want to avoid a situation where a contribution requires extensive rework (by you or by us), sits in backlog for a long time, or cannot be accepted at all!**

If you would like to implement a new feature, please **FIXME** [raise an issue](https://github.com/ibm/repo-template/issues)
before sending a pull request so the feature can be discussed. This is to avoid
you wasting your valuable time working on a feature that the project developers
are not interested in accepting into the code base.
### Proposing new examples

If you would like to implement a new example, please [raise an issue](https://github.com/IBM/db2-samples/issues) before sending a pull request so the feature can be discussed. This is to avoid you wasting your valuable time working on a feature that the project Maintainers may not be interested in accepting into the code base.

### Fixing bugs

If you would like to fix a bug, please **FIXME** [raise an issue](https://github.com/ibm/repo-template/issues) before sending a
pull request so it can be tracked.
If you would like to fix a bug, please [raise an issue](https://github.com/IBM/db2-samples/issues) before sending a pull request so it can be tracked.

### Merge approval

The project maintainers use LGTM (Looks Good To Me) in comments on the code
review to indicate acceptance. A change requires LGTMs from two of the
maintainers of each component affected.
The project Maintainers use review sign-off within GitHub on all changes to indicate acceptance. A change requires sign-off from at least one of the Maintainers of each component affected.

For a list of the maintainers, see the [MAINTAINERS.md](MAINTAINERS.md) page.
For a list of the Maintainers, see the [CODEOWNERS](CODEOWNERS) page.

## Legal

Each source file must include a license header for the Apache
Software License 2.0. Using the SPDX format is the simplest approach.
e.g.
Each source file must include a license header for the Apache Software License 2.0. Using the SPDX format is the simplest approach. e.g.

```
/*
Expand All @@ -46,39 +34,20 @@ SPDX-License-Identifier: Apache-2.0
*/
```

We have tried to make it as easy as possible to make contributions. This
applies to how we handle the legal aspects of contribution. We use the
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)
We have tried to make it as easy as possible to make contributions. This applies to how we handle the legal aspects of contribution. We use the 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)
uses to manage code contributions.

We simply ask that when submitting a patch for review, the developer
must include a sign-off statement in the commit message.

Here is an example Signed-off-by line, which indicates that the
submitter accepts the DCO:
We simply ask that when submitting a patch for review, the developer must include a sign-off statement in the commit message which indicates that the submitter accepts the terms of the DCO. Here is an example Signed-off-by line:

```
Signed-off-by: John Doe <john.doe@example.com>
Signed-off-by: Jane Doe <Jane.Doe@example.com>
```

You can include this automatically when you commit a change to your
local git repository using the following command:
You can include this automatically when you commit a change to your local git repository using the following command:

```
git commit -s
```

## Communication
**FIXME** Please feel free to connect with us on our [Slack channel](link).

## Setup
**FIXME** Please add any special setup instructions for your project to help the developer
become productive quickly.

## Testing
**FIXME** Please provide information that helps the developer test any changes they make
before submitting.

## Coding style guidelines
**FIXME** Optional, but recommended: please share any specific style guidelines you might
have for your project.
Please feel free to connect with us at our [GitHub Team](https://github.com/orgs/IBM/teams/db2-samples/discussions).

0 comments on commit 7fc8eb2

Please sign in to comment.