Skip to content

Commit

Permalink
Transfer to new maintainer
Browse files Browse the repository at this point in the history
  • Loading branch information
kjellmorten committed Oct 19, 2017
1 parent aee2a48 commit 56155ae
Show file tree
Hide file tree
Showing 5 changed files with 1,310 additions and 455 deletions.
94 changes: 94 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,94 @@
# Contributing

When contributing to this repository, please first discuss the change you wish
to make via [issues](https://github.com/kjellmorten/hapi-json-api/issues)
with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions
with the project.

## Pull Request Process

1. Make sure all tests pass, and that your contributions are well tested.
2. Update the README.md with details of changes to the interface.
3. Increase the version numbers in package.json to the new version that this
Pull Request would represent. The versioning scheme we use is
[SemVer](http://semver.org/).
4. Create a Pull Request and request one of the maintainers to review and merge
it for you.

## Code of Conduct

### Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of
experience, nationality, personal appearance, race, religion, or sexual identity
and orientation.

### Our Standards

Examples of behavior that contributes to creating a positive environment
include:

- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

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

### Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers 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, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

### Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

### Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at post@kjellmorten.no. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an
incident. Further details of specific enforcement policies may be posted
separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

### Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
3 changes: 2 additions & 1 deletion LICENSE.md
@@ -1,6 +1,7 @@
The MIT License (MIT)

Copyright (c) 2015 Michael Garvin
Copyright (c) 2015-2017 Michael Garvin
Copyright (c) 2017 Kjell-Morten Bratsberg Thorsen

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
39 changes: 23 additions & 16 deletions README.md
@@ -1,23 +1,22 @@
# New maintainer needed
# hapi-json-api

This module is currently not being maintained. If you would like to take over those responsibilities please see [this issue](https://github.com/wraithgar/hapi-json-api/issues/43)
Hapi plugin for enabling/enforcing [JSON-API specification](http://jsonapi.org).

# @gar/hapi-json-api
Original project transferred from [@wraithgar](https://github.com/wraithgar).

[![Greenkeeper badge](https://badges.greenkeeper.io/wraithgar/hapi-json-api.svg)](https://greenkeeper.io/)
[![Greenkeeper badge](https://badges.greenkeeper.io/kjellmorten/hapi-json-api.svg)](https://greenkeeper.io/)
[![Build Status](https://travis-ci.org/kjellmorten/hapi-json-api.svg?branch=master)](https://travis-ci.org/kjellmorten/hapi-json-api)
[![NSP Status](https://nodesecurity.io/orgs/laboreum/projects/933c42d1-7af0-4d0b-82b5-08c4915afe6b/badge)](https://nodesecurity.io/orgs/laboreum/projects/933c42d1-7af0-4d0b-82b5-08c4915afe6b)

hapi plugin for enabling/enforcing json-api
## Getting started

[![Build Status](https://travis-ci.org/wraithgar/hapi-json-api.svg?branch=master)](https://travis-ci.org/wraithgar/hapi-json-api)
[![NSP Status](https://nodesecurity.io/orgs/wraithgar/projects/2fc98c1d-70b1-4d2a-b6ee-dd9d2dd19282/badge)](https://nodesecurity.io/orgs/wraithgar/projects/2fc98c1d-70b1-4d2a-b6ee-dd9d2dd19282)

## installing
### Installing

```shell
npm install @gar/hapi-json-api
```

## use
## Example of use

```javascript
//where server is a hapi server
Expand All @@ -28,16 +27,24 @@ server.register({
});
```

## options
### Configuration

Pass an optional `meta` parameter to options to have that included in
the `meta` response namespace for all replies from your server

## notes
## Features

- Enforces Accept/Content-type rules defined in spec

- Rewrites Boom errors to be spec compliant

**Note:** Objects coming back from your handlers is not validated as of now.
It is assumed to be in proper json-api format and simply passed on.

## Contributing

Assumes the objects coming back from your handlers return data in proper
json-api format. No validation yet.
Please read [CONTRIBUTING](https://github.com/kjellmorten/hapi-json-api/blob/master/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests.

Rewrites Boom errors to be spec compliant.
## License

Enforces Accept/Content-type rules defined in spec
This project is licensed under the MIT License - see the [LICENSE](https://github.com/kjellmorten/hapi-json-api/blob/master/LICENSE.md) file for details.

0 comments on commit 56155ae

Please sign in to comment.