~samwhited/clarkns

7eacd4ea6aa09f772fc349b3cc3562f2ed791d13 — Sam Whited 1 year, 3 months ago 45d08b0 master
Add boilerplate documentation and CI config
A .builds/ci.yml => .builds/ci.yml +33 -0
@@ 0,0 1,33 @@
image: freebsd/latest
packages:
  - go
sources:
  - https://github.com/mellium/clarkns
tasks:
  - setup: |
      go version
      go env

      go get -u golang.org/x/lint/golint
      go get -u github.com/securego/gosec/cmd/gosec
      go get -u git.sr.ht/~samwhited/checkdoc

      echo 'export PATH=$(go env GOPATH)/bin:$PATH' >> ~/.buildenv
  - info: |
      go version
      go env
  - test: |
      cd clarkns/
      go test -v -cover ./...
  - lint: |
      cd clarkns/
      go vet ./...
      gofmt -s -l . && [ -z "$(gofmt -s -l .)" ]

      golint -set_exit_status ./...
      gosec ./...
      checkdoc ./...
  - validate: |
      cd clarkns/
      go mod tidy
      git diff --exit-code -- go.mod go.sum

A .builds/dco.yml => .builds/dco.yml +27 -0
@@ 0,0 1,27 @@
image: alpine/edge
packages:
  - git
sources:
  - https://github.com/mellium/clarkns
tasks:
  - dco: |
      git version
      cd clarkns/
      function on_err {
        cat <<EOF
      Failed to sign the Developer Certificate of Origin (DCO)!
      Please read the file "DCO" and then, if you agree, sign each of your commits
      using:

          git commit -s

      Or quickly sign the previous commit with:

          git commit --amend -s --no-edit
      EOF
      }
      trap on_err ERR

      # Check that all commits that aren't in master are signed off by the same
      # committer (taken from the HEAD commit).
      [[ ! "$(git log --invert-grep --grep="Signed-off-by: $(git show -s --pretty="%cn <%ce>" HEAD)" master..)" ]]

A .builds/sync.yml => .builds/sync.yml +13 -0
@@ 0,0 1,13 @@
image: alpine/edge
secrets:
  - d66b1d1c-77da-4c7c-bd7a-afe0f83f34ed
  - cfc0975b-ca64-48e2-ae20-43767e03ab51
tasks:
  - info: |
      [ -z "$GITHUB_EVENT" ] || complete-build
      git version
  - sync: |
      git clone --reference ./clarkns --mirror https://git.sr.ht/~samwhited/clarkns clarkns.git
      cd clarkns.git/
      cat ~/.ssh/github >> ~/.ssh/known_hosts
      git push --mirror git@github.com:mellium/clarkns.git

A DCO => DCO +37 -0
@@ 0,0 1,37 @@
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

A LICENSE => LICENSE +23 -0
@@ 0,0 1,23 @@
Copyright © 2020 The Mellium Contributors.
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

2. 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.

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.

A README.md => README.md +36 -0
@@ 0,0 1,36 @@
# mellium.im/clarkns

[![Issue Tracker][badge]](https://github.com/mellium/clarkns/issues)
[![GoDoc](https://godoc.org/mellium.im/clarkns?status.svg)](https://pkg.go.dev/mellium.im/clarkns)
[![Chat](https://inverse.chat/badge.svg?room=mellium@conference.samwhited.com)](https://conversations.im/j/mellium@conference.samwhited.com)
[![License](https://img.shields.io/badge/license-FreeBSD-blue.svg)](https://opensource.org/licenses/BSD-2-Clause)
[![Build Status](https://builds.sr.ht/~samwhited/clarkns.svg)](https://builds.sr.ht/~samwhited/clarkns?)

[![Buy Me A Coffee](https://www.buymeacoffee.com/assets/img/custom_images/purple_img.png)](https://www.buymeacoffee.com/samwhited)
[![Support Me](https://liberapay.com/assets/widgets/donate.svg)](https://liberapay.com/SamWhited/donate)

An API for parsing [Clark Notation] into XML names in Go.

To use it in your project, import it like so:

```go
import "mellium.im/clarkns"
```

If you'd like to contribute to the project, see [CONTRIBUTING.md].


## License

The package may be used under the terms of the BSD 2-Clause License a copy of
which may be found in the [LICENSE] file.

Unless you explicitly state otherwise, any contribution submitted for inclusion
in the work by you shall be licensed as above, without any additional terms or
conditions.


[badge]: https://img.shields.io/badge/style-mellium%2fxmpp-green.svg?longCache=true&style=popout-square&label=issues
[Clark Notation]: http://www.jclark.com/xml/xmlns.htm
[CONTRIBUTING.md]: https://github.com/mellium/xmpp/blob/master/docs/CONTRIBUTING.md
[LICENSE]: ./LICENSE

A docs/CODE_OF_CONDUCT.md => docs/CODE_OF_CONDUCT.md +6 -0
@@ 0,0 1,6 @@
# Code of Conduct

The Code of Conduct for all Mellium projects can be found in the main repo under
[`docs/CODE_OF_CONDUCT.md`].

[`docs/CODE_OF_CONDUCT.md`]: https://github.com/mellium/xmpp/blob/master/docs/CODE_OF_CONDUCT.md

A docs/CONTRIBUTING.md => docs/CONTRIBUTING.md +7 -0
@@ 0,0 1,7 @@
# Contributing

Thanks for wanting to contribute to Mellium! Before submitting a patch, please
read the [Code of Conduct] and the [Contributing Guide] from the main repo.

[Code of Conduct]: https://github.com/mellium/xmpp/blob/master/docs/CODE_OF_CONDUCT.md
[Contributing Guide]: https://github.com/mellium/xmpp/blob/master/docs/CONTRIBUTING.md

A docs/FUNDING.yml => docs/FUNDING.yml +12 -0
@@ 0,0 1,12 @@
# These are supported funding model platforms

github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
patreon: # Replace with a single Patreon username
open_collective: # Replace with a single Open Collective username
ko_fi: # Replace with a single Ko-fi username
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
liberapay: SamWhited
issuehunt: # Replace with a single IssueHunt username
otechie: # Replace with a single Otechie username
custom: ['https://www.buymeacoffee.com/samwhited']

A docs/SECURITY.md => docs/SECURITY.md +6 -0
@@ 0,0 1,6 @@
# Security Policy

The security policy for all Mellium projects can be found in the main repo under
[`docs/SECURITY.md`].

[`docs/SECURITY.md`]: https://github.com/mellium/xmpp/blob/master/docs/SECURITY.md

A docs/SUPPORT.md => docs/SUPPORT.md +6 -0
@@ 0,0 1,6 @@
# Support Policy

The support policy for all Mellium projects can be found in the main repo under
[`docs/SUPPORT.md`].

[`docs/SUPPORT.md`]: https://github.com/mellium/xmpp/blob/master/docs/SUPPORT.md