From cfa0b62f61d49ced1cd0cf94ee14ef72ec5990d0 Mon Sep 17 00:00:00 2001
From: Travis Ralston <travpc@gmail.com>
Date: Sun, 29 Dec 2019 16:17:12 -0700
Subject: [PATCH] Add some supporting documentation (contributing.md/changelog)
---
.circleci/config.yml | 3 --
CHANGELOG.md | 32 +++++++++++++++
CONTRIBUTING.md | 94 ++++++++++++++++++++++++++++++++++++++++++++
appveyor.yml | 3 --
4 files changed, 126 insertions(+), 6 deletions(-)
create mode 100644 CHANGELOG.md
create mode 100644 CONTRIBUTING.md
diff --git a/.circleci/config.yml b/.circleci/config.yml
index d7e0507d..0dbb283c 100644
--- a/.circleci/config.yml
+++ b/.circleci/config.yml
@@ -22,6 +22,3 @@ workflows:
build_and_test:
jobs:
- build:
- filters:
- branches:
- only: [master, develop]
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 00000000..7d17acda
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,32 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to
+[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+<!--## [1.0.0-rc.1] - December 29, 2019-->
+
+### Added
+
+* First ever release of matrix-media-repo.
+* Deduplicate media from all sources.
+* Support downloads, thumbnails, URL previews, identicons.
+* Support for GDPR-style media exports.
+* Support for importing from a previous export (for transferring data between repos).
+* Admin utilities for clearing up space and undesirable content.
+* Built-in S3 (and S3-like) support.
+* Animated thumbnail generation.
+* Importing media from an existing Synapse homeserver.
+* Support for multiple datastores/locations to store different kinds of media.
+* Federation for acquiring remote media.
+* Media identification ([MSC2380](https://github.com/matrix-org/matrix-doc/pull/2380)).
+* Support for cloning media to the local homeserver.
+* Various other features that would be expected like maximum/minimum size controls, rate limiting, etc. Check out the
+ sample config for a better idea of what else is possible.
+
+[unreleased]: https://github.com/turt2live/matrix-media-repo/compare/v1.0.0-rc.1...HEAD
+[1.0.0]: https://github.com/turt2live/matrix-media-repo/compare/v1.0.0-rc.1...v1.0.0
+[1.0.0-rc.1]: https://github.com/turt2live/matrix-media-repo/releases/tag/v1.0.0-rc.1
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000..21f87908
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,94 @@
+# Contributing guidelines
+
+Everyone is welcome to contribute code to this project, provided that they are willing to license their contributions
+under the same license as the project itself. We follow a simple 'inbound=outbound' model for contributions: the act
+of submitting an 'inbound' contribution means that the contributor agrees to license the code under the same terms as
+the project's overall 'outbound' license - in our case, this is the MIT license (see [LICENSE](LICENSE)).
+
+## How to contribute
+
+The preferred and easiest way to contribute changes is to fork it on GitHub, and then
+[create a pull request](https://help.github.com/articles/using-pull-requests/) to ask us to pull your changes into our repo.
+
+We use several CI systems for testing PRs and the project in general. After opening your pull request, the build status
+will be shown on GitHub. Please ensure your PR passes the builds before asking for review.
+
+This project does not currently have unit or integration tests, though it is expected that your changes work. Please test
+them locally and provide a detailed description on how they are supposed to work.
+
+## Code style
+
+This project doesn't yet have a linter because GoLand's default formatting rules seem good enough. If your code looks
+sensible and roughly in the same shape as the code surrounding it, it will be fine.
+
+## Changelog
+
+Please document relevant changes in the [CHANGELOG.md](CHANGELOG.md) file. We use keep-a-changelog's format, so some
+headers may need to be created.
+
+## Sign off
+
+In order to have a concrete record that your contribution is intentional and you agree to license it under the same
+terms as the project's license, we've adopted the same lightweight approach that the Linux Kernel
+[submitting patches process](
+https://www.kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin>),
+[Docker](https://github.com/docker/docker/blob/master/CONTRIBUTING.md), and many other projects use: the DCO (Developer
+Certificate of Origin: http://developercertificate.org/). This is a simple declaration that you wrote the contribution
+or otherwise have the right to contribute it to us:
+
+```
+Developer Certificate of Origin
+Version 1.1
+
+Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
+660 York Street, Suite 102,
+San Francisco, CA 94110 USA
+
+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.
+```
+
+If you agree to this for your contribution, then all that's needed is to
+include the line in your commit or pull request comment:
+
+```
+Signed-off-by: Your Name <your@email.example.org>
+```
+
+We accept contributions under a legally identifiable name, such as your name on government documentation or common-law
+names (names claimed by legitimate usage or repute). Unfortunately, we cannot accept anonymous contributions at this time.
+
+Git allows you to add this signoff automatically when using the `-s` flag to `git commit`, which uses the name and email
+set in your `user.name` and `user.email` git configs.
+
+## Conclusion
+
+That's it! This project can be difficult to jump into, but we do appreciate collaboration and open communication. We've
+adapted these contributing guidelines from [Synapse](https://github.com/matrix-org/synapse/blob/master/CONTRIBUTING.md)
+because we believe in Matrix's mission - we hope you do too and welcome you to our project!
diff --git a/appveyor.yml b/appveyor.yml
index ff96c5ff..e25502bd 100644
--- a/appveyor.yml
+++ b/appveyor.yml
@@ -6,9 +6,6 @@ environment:
GOPATH: c:\gopath
GOVERSION: 1.12
-branches:
- only: [master, develop]
-
init:
- git config --global core.autocrlf input
--
GitLab