From 1c2689487e7ac8cb3a0b6f4a511e3d9a1212f8a3 Mon Sep 17 00:00:00 2001 From: Justin Mazzocchi <2831158+jzzocc@users.noreply.github.com> Date: Fri, 19 Mar 2021 20:33:46 -0700 Subject: [PATCH] Update README --- CONTRIBUTING.md | 7 +++++++ README.md | 6 +++--- 2 files changed, 10 insertions(+), 3 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c0ed82e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,7 @@ +# Metatext Contribution Guidelines + +See the [architecture section](https://github.com/metabolist/metatext/blob/main/README.md#architecture) of Metatext's README for an overview of Metatext's code. Make sure you have [SwiftLint](https://github.com/realm/SwiftLint) installed and there are no warnings. + +## Sign the Contributor License Agreement (CLA) + +In order to publish Metatext's source code under the GNU General Public License and be able to dual-license Metatext to Apple for distribution on the App Store, Metabolist must be the sole copyright holder to Metatext's source code. You will need to [sign Metabolist's CLA](https://metabolist.org/cla/) before your pull request can be merged. diff --git a/README.md b/README.md index 80c26cb..ae53462 100644 --- a/README.md +++ b/README.md @@ -10,11 +10,11 @@ GitHub is used for bug tracking. Please search [existing issues](https://github. ## Contributing Code -See the [architecture section](#Architecture) for an overview of Metatext's code. Make sure you have [SwiftLint](https://github.com/realm/SwiftLint) installed and there are no warnings. +See the [contribution guidelines](https://github.com/metabolist/metatext/blob/main/CONTRIBUTING.md). -### Sign the Contributor License Agreement (CLA) +## Contributing Ideas -In order to publish Metatext's source code under the GNU General Public License and be able to dual-license Metatext to Apple for distribution on the App Store, Metabolist must be the sole copyright holder to Metatext's source code. You will need to [sign Metabolist's CLA](https://metabolist.org/cla/) before your pull request can be merged. +Check out Metatext's [discussions on GitHub](https://github.com/metabolist/metatext/discussions). ## Building