From 1216ecf7f83526004594634dddcf1df02d565a70 Mon Sep 17 00:00:00 2001 From: j4qfrost Date: Mon, 14 Nov 2022 19:07:16 -0800 Subject: [PATCH] docs: Sort out licensing and contributors (#134) * clean up licensing * move readme --- .github/README.md | 1 - CONTRIBUTING.md | 20 ++++------ LICENSE | 2 +- README.md | 39 +++++++++++++++++++ packages/common/LICENSE | 12 +++--- packages/common_test/LICENSE | 2 +- .../common_test/lib/conduit_common_test.dart | 2 - packages/conduit/README.md | 29 +------------- packages/test_harness/LICENSE | 2 +- 9 files changed, 57 insertions(+), 52 deletions(-) delete mode 120000 .github/README.md create mode 100644 README.md mode change 100644 => 120000 packages/conduit/README.md diff --git a/.github/README.md b/.github/README.md deleted file mode 120000 index cb17e42ca..000000000 --- a/.github/README.md +++ /dev/null @@ -1 +0,0 @@ -../packages/conduit/README.md \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b5e90cb65..87b506e1e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,24 +12,17 @@ refactor/- If the scope of the issue changes for any reason, please rebranch and use the appropriate anming convention. ## Local Testing -While we do provide CI/CD through github actions, it is slow to get results on the CI. You should set up your environment in order to run tests locally before pushing commits +While we do provide CI/CD through github actions, it is slow to get results on the CI. You should set up your environment in order to run tests locally before pushing commits. + ### Setup -To set up your testing environment, a general rule is to follow what is provided in the CI configurations: -```bash -# This can be found in .github/workflows/test.yml -dart pub global activate melos -cd packages/isolate_exec_test_packages/test_package && dart pub get -melos bootstrap -melos cache-source -. ./ci/.env -``` -Provide a database with the appropriate configurations. I highly recommend that you [install docker](https://docs.docker.com/get-docker/) and use the provided docker compose file at (ci/docker-compose.yaml) which sets up a similar database used in the github CI. +To set up your testing environment, a general rule is to follow what is provided in the CI configurations. There are workflow files under (.github/workflows) for each platform, which should give you an idea about how to set up your environment appropriately. Provide a database with the appropriate configurations. I highly recommend that you [install docker](https://docs.docker.com/get-docker/) and use the provided docker compose file at (ci/docker-compose.yaml) which sets up a similar database used in the github CI. + ### Running Tests Currently there are three tests that need to be run to hit all the tests: ```bash melos test-unit # These two need to be run inside packages/conduit -dart test -j1 -t cli test/* +dart test -j1 -t cli test/* # use dart test -j1 -t cli for windows and macos dart tool/generated_test_runner.dart ``` The first will run all the unit tests in conduit and all its dependencies. The last two test cli components and string-compiled code respectively. @@ -39,3 +32,6 @@ Please document the intent of the pull request. All non-documentation pull reque ## Commits The project uses [melos](https://pub.dev/packages/melos) for tooling, which provides autoversioning based on [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/). Commits to `master` will usually be squashed from PRs, so make sure that the PR name uses conventional commits to trigger the versioning and publishing CI; you do NOT need to use conventional commits on each commit to your branch. + +## Licensing +The predessor project, [Aqueduct](https://www.github.com/stablekernel/aquedect), and the corresponding dependencies will retain their BSD and MIT licenses copyrighted by stablekernel. Any subsequent work done on Conduit and changes to dependencies will fall under the BSD-2 liecense attirbuted to conduit-dart and fellow contributors. So any additional package created from scratch for this mono-repo must contain the root level license. \ No newline at end of file diff --git a/LICENSE b/LICENSE index 63e10237d..79428841f 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright (c) 2018, Stable Kernel LLC +Copyright (c) 2021, conduit-dart and 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: diff --git a/README.md b/README.md new file mode 100644 index 000000000..6404702b8 --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ + + +[![Test Suite](https://github.com/conduit-dart/conduit/actions/workflows/test.yml/badge.svg)](https://github.com/conduit-dart/conduit/actions/workflows/test.yml) [](https://discord.gg/MHz5cqktHW) + +Conduit is a fork of Stablekernel's Aqueduct, a modern Dart HTTP server framework. + +## Getting Started + +1. [Install Dart](https://www.dartlang.org/install). +2. Activate Conduit. +``` +dart pub global activate conduit +``` +3. Create a new project. +``` +conduit create my_project +``` +4. Serve the project. +``` +cd my_project +conduit serve +``` + +## Tutorials, Documentation and Examples + +We are currently in the process of collating helpful resources for your edification. Our main docs live [here](https://docs.theconduit.dev/). + +Conduit is a close fork to Aqueduct, so Aqueduct examples can be tweaked to work with Conduit [here](https://github.com/stablekernel/aqueduct_examples). The major concern is updating the code to use null-safety. + +## Contributors + + + + + + + + + \ No newline at end of file diff --git a/packages/common/LICENSE b/packages/common/LICENSE index 65da463d3..7d927b39c 100644 --- a/packages/common/LICENSE +++ b/packages/common/LICENSE @@ -1,17 +1,17 @@ BSD 2-Clause License -Copyright (c) 2021, Conduit +Copyright (c) 2018, stable/kernel 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. +* 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. +* 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 diff --git a/packages/common_test/LICENSE b/packages/common_test/LICENSE index ec5f1079e..7d927b39c 100644 --- a/packages/common_test/LICENSE +++ b/packages/common_test/LICENSE @@ -1,6 +1,6 @@ BSD 2-Clause License -Copyright (c) 2018, stable/kernel, noojee and others +Copyright (c) 2018, stable/kernel All rights reserved. Redistribution and use in source and binary forms, with or without diff --git a/packages/common_test/lib/conduit_common_test.dart b/packages/common_test/lib/conduit_common_test.dart index 92450e8a1..21e673f4d 100644 --- a/packages/common_test/lib/conduit_common_test.dart +++ b/packages/common_test/lib/conduit_common_test.dart @@ -1,3 +1 @@ -// export 'src/db/postgres/db_settings.dart'; -// export 'src/db/postgres/postgres_manager.dart'; export 'src/db/postgres/postgres_test_config.dart'; diff --git a/packages/conduit/README.md b/packages/conduit/README.md deleted file mode 100644 index 27b6a702e..000000000 --- a/packages/conduit/README.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[![Test Suite](https://github.com/conduit-dart/conduit/actions/workflows/test.yml/badge.svg)](https://github.com/conduit-dart/conduit/actions/workflows/test.yml) [](https://discord.gg/MHz5cqktHW) - -Conduit is a fork of Stablekernel's Aqueduct, a modern Dart HTTP server framework. - -## Getting Started - -1. [Install Dart](https://www.dartlang.org/install). -2. Activate Conduit. -``` -dart pub global activate conduit -``` -3. Create a new project. -``` -conduit create my_project -``` -4. Serve the project. -``` -cd my_project -conduit serve -``` - -## Tutorials, Documentation and Examples - -We are currently in the process of collating helpful resources for your edification. Our main docs live [here](https://docs.theconduit.dev/). - -Conduit is a close fork to Aqueduct, so Aqueduct examples can be tweaked to work with Conduit [here](https://github.com/stablekernel/aqueduct_examples). The major concern is updating the code to use null-safety. diff --git a/packages/conduit/README.md b/packages/conduit/README.md new file mode 120000 index 000000000..fe8400541 --- /dev/null +++ b/packages/conduit/README.md @@ -0,0 +1 @@ +../../README.md \ No newline at end of file diff --git a/packages/test_harness/LICENSE b/packages/test_harness/LICENSE index ec5f1079e..7d927b39c 100644 --- a/packages/test_harness/LICENSE +++ b/packages/test_harness/LICENSE @@ -1,6 +1,6 @@ BSD 2-Clause License -Copyright (c) 2018, stable/kernel, noojee and others +Copyright (c) 2018, stable/kernel All rights reserved. Redistribution and use in source and binary forms, with or without