mirror of
https://github.com/burrowers/garble.git
synced 2025-09-26 20:01:16 +08:00
set up an AUTHORS file to attribute copyright
Many files were missing copyright, so also add a short script to add the missing lines with the current year, and run it. The AUTHORS file is also self-explanatory. Contributors can add themselves there, or we can simply update it from time to time via git-shortlog. Since we have two scripts now, set up a directory for them.
This commit is contained in:
3
.github/workflows/test.yml
vendored
3
.github/workflows/test.yml
vendored
@@ -42,10 +42,11 @@ jobs:
|
|||||||
run: |
|
run: |
|
||||||
go version
|
go version
|
||||||
go test ./...
|
go test ./...
|
||||||
|
|
||||||
code-checks:
|
code-checks:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout code
|
- name: Checkout code
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v2
|
||||||
- name: Test that only LF line endings are used
|
- name: Test that only LF line endings are used
|
||||||
run: bash crlf_test.sh
|
run: ./scripts/crlf-test.sh
|
||||||
|
14
AUTHORS
Normal file
14
AUTHORS
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
# This is the official list of Garble authors for copyright purposes.
|
||||||
|
|
||||||
|
# Names should be added to this file as one of
|
||||||
|
# Organization's name
|
||||||
|
# Individual's name <submission email address>
|
||||||
|
|
||||||
|
# Please keep the list sorted.
|
||||||
|
|
||||||
|
Andrew LeFevre <jalefevre@liberty.edu>
|
||||||
|
Daniel Martí <mvdan@mvdan.cc>
|
||||||
|
Nicholas Jones <me@nicholasjon.es>
|
||||||
|
Zachary Wasserman <zachwass2000@gmail.com>
|
||||||
|
lu4p <lu4p@pm.me>
|
||||||
|
pagran <pagran@protonmail.com>
|
@@ -7,6 +7,9 @@ Thank you for your interest in contributing! Here are some ground rules:
|
|||||||
3. All contributions are done in PRs with at least one review and CI
|
3. All contributions are done in PRs with at least one review and CI
|
||||||
4. We use the `#obfuscation` channel over at the [Gophers Slack](https://invite.slack.golangbridge.org/) to chat
|
4. We use the `#obfuscation` channel over at the [Gophers Slack](https://invite.slack.golangbridge.org/) to chat
|
||||||
|
|
||||||
|
When contributing for the first time, you should also add yourself to the
|
||||||
|
[AUTHORS file](AUTHORS).
|
||||||
|
|
||||||
### Testing
|
### Testing
|
||||||
|
|
||||||
Just the usual `go test ./...`; many of the tests are in
|
Just the usual `go test ./...`; many of the tests are in
|
||||||
|
2
LICENSE
2
LICENSE
@@ -1,4 +1,4 @@
|
|||||||
Copyright (c) 2019, Daniel Martí. All rights reserved.
|
Copyright (c) 2019, The Garble Authors.
|
||||||
|
|
||||||
Redistribution and use in source and binary forms, with or without
|
Redistribution and use in source and binary forms, with or without
|
||||||
modification, are permitted provided that the following conditions are
|
modification, are permitted provided that the following conditions are
|
||||||
|
@@ -1,5 +1,5 @@
|
|||||||
// Copyright (c) 2020, Daniel Martí <mvdan@mvdan.cc>
|
// Copyright (c) 2020, The Garble Authors.
|
||||||
// See LICENSE for licensing information
|
// See LICENSE for licensing information.
|
||||||
|
|
||||||
package main
|
package main
|
||||||
|
|
||||||
|
@@ -1,3 +1,6 @@
|
|||||||
|
// Copyright (c) 2020, The Garble Authors.
|
||||||
|
// See LICENSE for licensing information.
|
||||||
|
|
||||||
package main
|
package main
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
@@ -1,3 +1,6 @@
|
|||||||
|
// Copyright (c) 2020, The Garble Authors.
|
||||||
|
// See LICENSE for licensing information.
|
||||||
|
|
||||||
package asthelper
|
package asthelper
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
@@ -1,3 +1,6 @@
|
|||||||
|
// Copyright (c) 2020, The Garble Authors.
|
||||||
|
// See LICENSE for licensing information.
|
||||||
|
|
||||||
package literals
|
package literals
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
@@ -1,3 +1,6 @@
|
|||||||
|
// Copyright (c) 2020, The Garble Authors.
|
||||||
|
// See LICENSE for licensing information.
|
||||||
|
|
||||||
package literals
|
package literals
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
@@ -1,3 +1,6 @@
|
|||||||
|
// Copyright (c) 2020, The Garble Authors.
|
||||||
|
// See LICENSE for licensing information.
|
||||||
|
|
||||||
package literals
|
package literals
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
@@ -1,3 +1,6 @@
|
|||||||
|
// Copyright (c) 2020, The Garble Authors.
|
||||||
|
// See LICENSE for licensing information.
|
||||||
|
|
||||||
package literals
|
package literals
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
@@ -1,3 +1,6 @@
|
|||||||
|
// Copyright (c) 2020, The Garble Authors.
|
||||||
|
// See LICENSE for licensing information.
|
||||||
|
|
||||||
package literals
|
package literals
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
@@ -1,3 +1,6 @@
|
|||||||
|
// Copyright (c) 2020, The Garble Authors.
|
||||||
|
// See LICENSE for licensing information.
|
||||||
|
|
||||||
package literals
|
package literals
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
@@ -1,3 +1,6 @@
|
|||||||
|
// Copyright (c) 2020, The Garble Authors.
|
||||||
|
// See LICENSE for licensing information.
|
||||||
|
|
||||||
package literals
|
package literals
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
@@ -1,3 +1,6 @@
|
|||||||
|
// Copyright (c) 2020, The Garble Authors.
|
||||||
|
// See LICENSE for licensing information.
|
||||||
|
|
||||||
package main
|
package main
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
4
main.go
4
main.go
@@ -1,5 +1,5 @@
|
|||||||
// Copyright (c) 2019, Daniel Martí <mvdan@mvdan.cc>
|
// Copyright (c) 2019, The Garble Authors.
|
||||||
// See LICENSE for licensing information
|
// See LICENSE for licensing information.
|
||||||
|
|
||||||
package main
|
package main
|
||||||
|
|
||||||
|
@@ -1,5 +1,5 @@
|
|||||||
// Copyright (c) 2019, Daniel Martí <mvdan@mvdan.cc>
|
// Copyright (c) 2019, The Garble Authors.
|
||||||
// See LICENSE for licensing information
|
// See LICENSE for licensing information.
|
||||||
|
|
||||||
package main
|
package main
|
||||||
|
|
||||||
|
@@ -1,3 +1,6 @@
|
|||||||
|
// Copyright (c) 2020, The Garble Authors.
|
||||||
|
// See LICENSE for licensing information.
|
||||||
|
|
||||||
package main
|
package main
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
3
crlf_test.sh → scripts/crlf-test.sh
Normal file → Executable file
3
crlf_test.sh → scripts/crlf-test.sh
Normal file → Executable file
@@ -1,4 +1,5 @@
|
|||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
|
|
||||||
if \
|
if \
|
||||||
grep \
|
grep \
|
||||||
--recursive \
|
--recursive \
|
||||||
@@ -16,4 +17,4 @@ if \
|
|||||||
fi
|
fi
|
||||||
|
|
||||||
echo -e "No files with CRLF endings found."
|
echo -e "No files with CRLF endings found."
|
||||||
exit 0
|
exit 0
|
11
scripts/ensure-copyrights.sh
Executable file
11
scripts/ensure-copyrights.sh
Executable file
@@ -0,0 +1,11 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
for f in $(git ls-files '*.go'); do
|
||||||
|
if ! grep -q Copyright $f; then
|
||||||
|
sed -i '1i\
|
||||||
|
// Copyright (c) 2020, The Garble Authors.\
|
||||||
|
// See LICENSE for licensing information.\
|
||||||
|
|
||||||
|
' $f
|
||||||
|
fi
|
||||||
|
done
|
3
testdata/bench/main.go
vendored
3
testdata/bench/main.go
vendored
@@ -1,3 +1,6 @@
|
|||||||
|
// Copyright (c) 2020, The Garble Authors.
|
||||||
|
// See LICENSE for licensing information.
|
||||||
|
|
||||||
package main
|
package main
|
||||||
|
|
||||||
import "fmt"
|
import "fmt"
|
||||||
|
Reference in New Issue
Block a user