Skip to content

Commit

Permalink
Prepare open source release (#9)
Browse files Browse the repository at this point in the history
* Add 3rd party licenses

* Add LICENSE

* Add file headers

* Add code of conduct

* Add bug report template

* Add a feature request template

* Add CONTRIBUTING.md
  • Loading branch information
gonzalezreal committed Jun 14, 2024
1 parent 1e9dad3 commit 5508dd2
Show file tree
Hide file tree
Showing 41 changed files with 489 additions and 0 deletions.
128 changes: 128 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[INSERT CONTACT METHOD].
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series
of actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
name: Bug Report
about: Create a report to help us improve
title: "[BUG] <Short description of the bug>"
labels: bug
assignees: ''

---

Thank you for contributing to JSONAPI!

Before you submit an issue, please complete the report with all the relevant details for your bug and go through every item in the checklist.

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

**Checklist**
- [ ] I can reproduce this issue with a vanilla Swift project.
- [ ] I can reproduce this issue using the `main` branch of this package.
- [ ] This bug hasn't been addressed in an [existing GitHub issue](https://github.com/Datadog/swift-jsonapi/issues).

**Steps to reproduce**
Explanation of how to reproduce the incorrect behavior. This could include an attached project, a link to code, or a JSON:API document exhibiting the issue.
1. ...

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

**Version information**
- JSONAPI: [e.g. 0.1.0, or a commit hash]
- OS: [e.g. iOS 15, macOS 13]
- Xcode: [e.g. 15.3.0]

**Additional context**
Add any other context about the problem here.
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
name: Feature Request
about: Suggest an idea for this project
title: "[FEATURE REQUEST] <Your title here>"
labels: enhancement
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**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 about the feature request here.

**Acceptance Criteria**
Describe the criteria for considering this feature request complete and satisfactory.

- [ ] Criteria 1
- [ ] Criteria 2
- [ ] Criteria 3

**Resources**
List any resources, links, or references that may be helpful for implementing this feature.

**Stakeholders**
Identify any stakeholders or user groups who would benefit from this feature.

**Related Issues**
Link any related issues or pull requests here.

---

*Please make sure to fill out all sections as much as possible to help us understand and implement your feature request effectively.*
50 changes: 50 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Contributing to JSONAPI

Thanks for considering contributing! Here are some guidelines to help you get started.

## Code of Conduct

This project follows the [Contributor Covenant Code of Conduct](.github/CODE_OF_CONDUCT.md). Please adhere to this code
in all interactions.

## How to Contribute

### Reporting Bugs

- **Search existing issues** to avoid duplicates.
- **Create a new issue** with a clear title and detailed description.
- Include steps to reproduce, expected behavior, and screenshots if applicable.

### Suggesting Enhancements

- **Search existing issues** for similar suggestions.
- **Create a new issue** with a clear title and detailed description.
- Explain the problem and the proposed solution.

### Pull Requests

1. **Fork** the repository.
2. **Clone** your fork and create a new branch.
3. **Commit** your changes with a descriptive message.
4. **Push** your branch to your fork.
5. **Open a pull request** against the main branch.

## Style Guides

### Commit Messages

- Use present tense (e.g., "Add feature" not "Added feature").
- Be concise and descriptive.
- Reference issues and pull requests when relevant.

### Code Style

- Follow the project's coding conventions.
- Ensure your code passes all tests.

## Additional Notes

- Use issue labels to categorize your issue or pull request.
- Engage in discussions and provide feedback.

Thank you for your contributions!
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 Datadog, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
5 changes: 5 additions & 0 deletions LICENSE-3rdparty.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Component,Origin,License,Copyright
SwiftSyntax,"https://github.com/apple/swift-syntax",Apache-2.0,Copyright (c) 2014 - 2024 Apple Inc. and the Swift project authors
Swift-DocC Plugin,"https://github.com/apple/swift-docc-plugin",Apache-2.0,Copyright (c) 2022 Apple Inc. and the Swift project authors
Swift Macro Testing,"https://github.com/pointfreeco/swift-macro-testing",MIT,Copyright (c) 2023 Point-Free
Swift Snapshot Testing,"https://github.com/pointfreeco/swift-snapshot-testing",MIT,"Copyright (c) 2019 Point-Free, Inc."
6 changes: 6 additions & 0 deletions Sources/JSONAPI/CompoundDocument.swift
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
// Unless explicitly stated otherwise all files in this repository are licensed under
// the MIT License.
//
// This product includes software developed at Datadog (https://www.datadoghq.com/).
// Copyright 2024-Present Datadog, Inc.

import Foundation

/// A JSON:API document that includes related resources along with the requested primary resources.
Expand Down
6 changes: 6 additions & 0 deletions Sources/JSONAPI/DefaultEmpty.swift
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
// Unless explicitly stated otherwise all files in this repository are licensed under
// the MIT License.
//
// This product includes software developed at Datadog (https://www.datadoghq.com/).
// Copyright 2024-Present Datadog, Inc.

import Foundation

/// A property wrapper that decodes a `nil` value into an empty instance.
Expand Down
6 changes: 6 additions & 0 deletions Sources/JSONAPI/InlineRelationshipMany.swift
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
// Unless explicitly stated otherwise all files in this repository are licensed under
// the MIT License.
//
// This product includes software developed at Datadog (https://www.datadoghq.com/).
// Copyright 2024-Present Datadog, Inc.

import Foundation

/// A JSON:API to-many relationship that includes the related resources.
Expand Down
6 changes: 6 additions & 0 deletions Sources/JSONAPI/InlineRelationshipOne.swift
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
// Unless explicitly stated otherwise all files in this repository are licensed under
// the MIT License.
//
// This product includes software developed at Datadog (https://www.datadoghq.com/).
// Copyright 2024-Present Datadog, Inc.

import Foundation

/// A JSON:API to-one relationship that includes the related resource.
Expand Down
6 changes: 6 additions & 0 deletions Sources/JSONAPI/InlineRelationshipOptional.swift
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
// Unless explicitly stated otherwise all files in this repository are licensed under
// the MIT License.
//
// This product includes software developed at Datadog (https://www.datadoghq.com/).
// Copyright 2024-Present Datadog, Inc.

import Foundation

/// A JSON:API optional to-one relationship that includes the related resource.
Expand Down
6 changes: 6 additions & 0 deletions Sources/JSONAPI/JSONAPIDecoder.swift
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
// Unless explicitly stated otherwise all files in this repository are licensed under
// the MIT License.
//
// This product includes software developed at Datadog (https://www.datadoghq.com/).
// Copyright 2024-Present Datadog, Inc.

import Foundation

/// An object that decodes JSON:API documents.
Expand Down
6 changes: 6 additions & 0 deletions Sources/JSONAPI/JSONAPIDecodingError.swift
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
// Unless explicitly stated otherwise all files in this repository are licensed under
// the MIT License.
//
// This product includes software developed at Datadog (https://www.datadoghq.com/).
// Copyright 2024-Present Datadog, Inc.

import Foundation

/// An error that occurs during the decoding of a JSON:API document.
Expand Down
6 changes: 6 additions & 0 deletions Sources/JSONAPI/JSONAPIEncoder.swift
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
// Unless explicitly stated otherwise all files in this repository are licensed under
// the MIT License.
//
// This product includes software developed at Datadog (https://www.datadoghq.com/).
// Copyright 2024-Present Datadog, Inc.

import Foundation

/// An object that encodes JSON:API documents.
Expand Down
6 changes: 6 additions & 0 deletions Sources/JSONAPI/Macros.swift
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
// Unless explicitly stated otherwise all files in this repository are licensed under
// the MIT License.
//
// This product includes software developed at Datadog (https://www.datadoghq.com/).
// Copyright 2024-Present Datadog, Inc.

/// Transforms a Swift struct into a JSON:API resource that can be encoded or decoded from a JSON:API response.
///
/// Annotate your models with the `@ResourceWrapper` macro to enable JSON:API encoding and decoding. At build time,
Expand Down
6 changes: 6 additions & 0 deletions Sources/JSONAPI/RelationshipMany.swift
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
// Unless explicitly stated otherwise all files in this repository are licensed under
// the MIT License.
//
// This product includes software developed at Datadog (https://www.datadoghq.com/).
// Copyright 2024-Present Datadog, Inc.

import Foundation

/// A JSON:API to-many relationship, tagged with the related resource type.
Expand Down
6 changes: 6 additions & 0 deletions Sources/JSONAPI/RelationshipOne.swift
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
// Unless explicitly stated otherwise all files in this repository are licensed under
// the MIT License.
//
// This product includes software developed at Datadog (https://www.datadoghq.com/).
// Copyright 2024-Present Datadog, Inc.

import Foundation

/// A JSON:API to-one relationship, tagged with the related resource type.
Expand Down
Loading

0 comments on commit 5508dd2

Please sign in to comment.