Skip to content

Commit

Permalink
Add licenses & more (#209)
Browse files Browse the repository at this point in the history
  • Loading branch information
gzussa authored and zippolyte committed Jan 3, 2020
1 parent 032a93e commit 0032f0b
Show file tree
Hide file tree
Showing 74 changed files with 634 additions and 20 deletions.
10 changes: 10 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# See https://help.github.com/articles/about-codeowners/ for syntax
# Rules are matched bottom-to-top, so one team can own subdirectories
# and another team can own the rest of the directory.

# All your base
* @DataDog/integrations-tools-and-libraries

# Documentation
*.md @DataDog/baklava @DataDog/integrations-tools-and-libraries
LICENSE @DataDog/baklava @DataDog/integrations-tools-and-libraries
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: 'kind/bug'
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

Label the issue properly.
- Add `severity/` label.
- Add `documentation` label if this issue is related to documentation changes.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Environment and Versions (please complete the following information):**
A clear and precise description of your setup:
- version for this project in use.
- services, libraries, languages and tools list and versions.

**Additional context**
Add any other context about the problem here.
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: 'kind/feature-request'
assignees: ''

---

**Note:**
If you have a feature request, you should [contact support](https://docs.datadoghq.com/help/) so the request can be properly tracked.

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is.

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
77 changes: 77 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
### Requirements for Contributing to this repository

* Fill out the template below. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.
* The pull request must only fix one issue, or add one feature, at the time.
* The pull request must update the test suite to demonstrate the changed functionality.
* After you create the pull request, all status checks must be pass before a maintainer reviews your contribution. For more details, please see [CONTRIBUTING](/CONTRIBUTING.md).

### What does this PR do?

<!--
What inspired you to submit this pull request?
Link to the issue describing the bug that you're fixing.
If there is not yet an issue for your bug, please open a new issue and then link to that issue in your pull request.
Note: In some cases, one person's "bug" is another person's "feature." If the pull request does not address an existing issue with the "bug" label, the maintainers have the final say on whether the current behavior is a bug.
-->

### Description of the Change

<!--
A brief description of the change being made with this pull request.
We must be able to understand the design of your change from this description.
If we can't get a good idea of what the code will be doing from the description here, the pull request may be closed at the maintainers' discretion.
Keep in mind that the maintainer reviewing this PR may not be familiar with or have worked with the code here recently, so please walk us through the concepts.
-->

### Alternate Designs

<!-- Explain what other alternates were considered and why the proposed version was selected -->

### Possible Drawbacks

<!-- What are the possible side-effects or negative impacts of the code change? -->

### Verification Process

<!--
What process did you follow to verify that your change has the desired effects?
- How did you verify that all new functionality works as expected?
- How did you verify that all changed functionality works as expected?
- How did you verify that the change has not introduced any regressions?
Describe the actions you performed (including scripts, commands you ran, etc.), and describe the results you observed.
-->

### Additional Notes

<!-- Anything else we should know when reviewing? -->

### Release Notes

<!--
If the PR title is not enough to describe the changes in a single line that explains this improvement in
terms that a user can understand. This text will be added in release notes.
For example, you can provide additionnal notes about feature deprecation or backward incompatible changes.
-->

### Review checklist (to be filled by reviewers)

- [ ] Feature or bug fix MUST have appropriate tests (unit, integration, etc...)
- [ ] PR title must be written as a CHANGELOG entry [(see why)](/CONTRIBUTING.md#pull-request-title)
- [ ] Files changes must correspond to the primary purpose of the PR as described in the title (small unrelated changes should have their own PR)
- [ ] PR must have one `changelog/` label attached. If applicable it should have the `backward-incompatible` label attached.
- [ ] PR should not have `do-not-merge/` label attached.
- [ ] If Applicable, issue must have `kind/` and `severity/` labels attached at least.

3 changes: 3 additions & 0 deletions .github/labeler.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Configuration for labeler - https://github.com/actions/labeler

documentation: "*.md"
11 changes: 11 additions & 0 deletions .github/workflows/labeler.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
name: "Pull Request Labeler"
on:
- pull_request

jobs:
triage:
runs-on: ubuntu-latest
steps:
- uses: actions/labeler@v2
with:
repo-token: "${{ secrets.GITHUB_TOKEN }}"
38 changes: 38 additions & 0 deletions .github/workflows/stale.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Configuration for https://github.com/actions/stale

name: "Stale issues and pull requests"
on:
schedule:
- cron: "0 0 * * *"

jobs:
stale:
runs-on: ubuntu-latest
steps:
- uses: actions/stale@v1
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
stale-issue-message: >-
Thanks for your contribution!
This issue has been automatically marked as stale because it has not had
activity in the last 30 days. Note that the issue will not be automatically
closed, but this notification will remind us to investigate why there's
been inactivity. Thank you for participating in the Datadog open source community.
If you would like this issue to remain open:
1. Verify that you can still reproduce the issue in the latest version of this project.
1. Comment that the issue is still reproducible and include updated details requested in the issue template.
days-before-stale: 30
stale-issue-label: 'stale'
exempt-issue-label: 'stale/exempt'
stale-pr-message: >-
This issue has been automatically marked as stale because it has not had activity in the last 30 days.
Note that the issue will not be automatically closed, but this notification will remind us to investigate why there's been inactivity.
stale-pr-label: 'stale'
exempt-pr-label: 'stale/exempt'
111 changes: 111 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
# How to contribute

First of all, thanks for contributing!

This document provides some basic guidelines for contributing to this repository. To propose improvements, feel free to submit a PR.

## Reporting a Bug - Requesting a feature - Github Issues

* **Ensure the bug was not already reported** by searching on GitHub under [Issues][1].
* If you're unable to find an open issue addressing the problem, [open a new one][2].
- **Fill out the issue template completely**. Label the issue properly.
- Add `severity/` label.
- Add `documentation` label if this issue is related to documentation changes.
* If you have a feature request, it is encouraged to [contact support][3] so the request can be prioritized and properly tracked.
* **Do not open an issue if you have a question**, instead [contact support][3].

## Suggesting an enhancements - Pull Requests

Have you fixed an issue? Many thanks!

Read the [development guide][/DEVELOPMENT.md] for more information on how to get started.

In order to ease/speed up our review, here are some items you can check/improve when submitting your PR:
* **Ensure an [Issue has been created](#reporting)**.
* Avoid changing too many things at once.
- Make sure that your Pull Requests only fixes one Issue at the time.
* **Write tests** for the code you wrote.
* Make sure that **all tests pass locally**.
* Summarize your PR with a **meaningful title** and **fill out the pull request description template completely!**
* Add the most suitable changelog label choosing one of the following:
* `changelog/Added` for new features.
* `changelog/Changed` for changes in existing functionality.
* `changelog/Deprecated` for soon-to-be removed features.
* `changelog/Removed` for now removed features.
* `changelog/Fixed` for any bug fixes.
* `changelog/Security` in case of vulnerabilities.
* `changelog/no-changelog` in case this PR should not appear in the changelog at all.

See [here][4] for more details about changelogs.

Your pull request must pass all CI tests before. If you're seeing
an error and don't think it's your fault, it may not be! [Join us on Slack][5] or send us an email, and together we'll
get it sorted out.

### Keep it small, focused

Avoid changing too many things at once. For instance if you're fixing two different
issues at once, it makes reviewing harder and the _time-to-release_ longer.

### Pull Request title

Unless the PR is marked with the proper exclusion label, the title will be used
to automatically fill the changelog entries. For this reason the title must be
concise but explanatory.

### Commit Messages

Please don't be this person: `git commit -m "Fixed stuff"`. Take a moment to
write meaningful commit messages.

The commit message should describe the reason for the change and give extra details
that will allow someone later on to understand in 5 seconds the thing you've been
working on for a day.

### Releasing

The release procedure is managed by Datadog, instructions can be found in the [RELEASING](/RELEASING.md) document.

## Asking a questions

Need help? Contact [Datadog support][3]

## Additional Notes

### Issue and Pull Request Labels

This section lists the labels we use to help us track and manage issues and pull requests.

| Label name | Usage | Description
|-------------------------------|--------------------------|------------------------------------------------------------
| `backward-incompatible` | Issues and Pull Requests | Warn for backward incompatible changes.
| `changelog/Added` | Pull Request Only | Added features results into a minor version bump.
| `changelog/Changed` | Pull Request Only | Changed features results into a major version bump.
| `changelog/Deprecated` | Pull Request Only | Deprecated features results into a major version bump.
| `changelog/Fixed` | Pull Request Only | Fixed features results into a bug fix version bump.
| `changelog/no-changelog` | Pull Request Only | Changes don't appear in changelog.
| `changelog/Removed` | Pull Request Only | Deprecated features results into a major version bump.
| `changelog/Security` | Pull Request Only | Fixed features results into a bug fix version bump.
| `community/help-wanted` | Issue Only | Community help wanted.
| `community` | Issues and Pull Requests | Community driven changes.
| `dev/testing` | Issues and Pull Requests | Tests related changes.
| `dev/tooling` | Issues and Pull Requests | Tooling related changes.
| `do-not-merge/HOLD` | Pull Request Only | Do not merge this PR.
| `do-not-merge/WIP` | Pull Request Only | Do not merge this PR.
| `documentation` | Issues and Pull Requests | Documentation related changes.
| `duplicate` | Issue Only | Duplicate issue.
| `invalid` | Issue Only | Invalid issue.
| `kind/bug` | Issue Only | Bug related issue.
| `kind/feature-request` | Issue Only | Feature request related issue.
| `severity/critical` | Issue Only | Critical severity issue.
| `severity/major` | Issue Only | Major severity issue.
| `severity/minor` | Issue Only | Minor severity issue.
| `severity/normal` | Issue Only | Normal severity issue.
| `stale` | Issues and Pull Requests | Stale - Bot reminder.
| `stale/exempt` | Issues and Pull Requests | Exempt from being marked as stale.

[1]: https://github.com/DataDog/dogapi-rb/issues
[2]: https://github.com/DataDog/dogapi-rb/issues/new
[3]: https://docs.datadoghq.com/help
[4]: https://keepachangelog.com/en/1.0.0
[5]: https://datadoghq.slack.com
11 changes: 11 additions & 0 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Development

The API implementation is located in the [`lib/dogapi`](lib/dogapi) folder.

## Testing

Test files are located in the [`spec`](spec) folder.

## Coding conventions

This project uses rubocop for linting.
41 changes: 21 additions & 20 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,25 +1,26 @@
Copyright (c) 2011, Datadog <[email protected]>
All rights reserved.
Copyright (c) 2011-Present, Datadog <[email protected]>

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
* Neither the name of the Datadog nor the
names of its contributors may be used to endorse or promote products
derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL DATADOG BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

* Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Loading

0 comments on commit 0032f0b

Please sign in to comment.