Skip to content

Commit

Permalink
Fix license etc.
Browse files Browse the repository at this point in the history
  • Loading branch information
raphael committed May 31, 2023
1 parent c3bed5a commit 5e3fe60
Show file tree
Hide file tree
Showing 3 changed files with 60 additions and 1 deletion.
38 changes: 38 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Contributing to Ponos

Thank you for your interest in contributing to the Ponos project! We appreciate
contributions via submitting Github issues and/or pull requests.

Below are some guidelines to follow when contributing to this project:

* Before opening an issue in Github, check [open issues](https://github.com/goadesign/ponos/issues)
and [pull requests](https://github.com/goadesign/ponos/pulls) for existing
issues and fixes.
* If your issue has not been addressed, [open a Github issue](https://github.com/goadesign/ponos/issues/new)
and follow the checklist presented in the issue description section. A simple
code snippet that reproduces your issue helps immensely.
* If you know how to fix your bug, we highly encourage PR contributions. See
[How Can I Get Started section](#how-can-i-get-started) on how to submit a PR.
* For feature requests and submitting major changes, [open an issue](https://github.com/goadesign/ponos/issues/new)
or hop on to our slack channel (see <https://goa.design> to join) to discuss
the feature first.
* Keep conversations friendly! Constructive criticism goes a long way.
* Have fun contributing!

## How Can I Get Started?

1) Go over the package README
2) To get your hands dirty, fork the Ponos repo and issue PRs from the fork.
**PRO Tip:** Add a [git remote](https://git-scm.com/docs/git-remote.html) to
your forked repo in the Ponos source code (in $GOPATH/src/goa.design/ponos when
installed using `go get`) to avoid messing with import paths while testing
your fix.
3) [Open issues](https://github.com/goadesign/ponos/issues) labeled as `good first
issue` are ideal to understand the source code and make minor contributions.
Issues labeled `help wanted` are bugs/features that are not currently being
worked on and contributing to them are most welcome.
4) Link the issue that the PR intends to solve in the PR description. If an issue
does not exist, adding a description in the PR that describes the issue and the
fix is recommended.
5) Ensure the CI build passes when you issue a PR to Ponos.
6) Join our slack channel (see <https://goa.design> to join)!
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2023 Raphael Simon and Ponos Contributors

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.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,4 +126,4 @@ behavior to [[email protected]](mailto:[email protected]).

## Credits

Ponos was originally created by [Raphael Simon](@raphael).
Ponos was originally created by [Raphael Simon](https://github.com/raphael).

0 comments on commit 5e3fe60

Please sign in to comment.