Skip to content

Commit

Permalink
docs: Sort out licensing and contributors (#134)
Browse files Browse the repository at this point in the history
* clean up licensing

* move readme
  • Loading branch information
j4qfrost committed Nov 15, 2022
1 parent b52195f commit 1216ecf
Show file tree
Hide file tree
Showing 9 changed files with 57 additions and 52 deletions.
1 change: 0 additions & 1 deletion .github/README.md

This file was deleted.

20 changes: 8 additions & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,24 +12,17 @@ refactor/<username>-<description>
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.
Expand All @@ -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.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
39 changes: 39 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
<img src="https://raw.githubusercontent.com/conduit-dart/conduit/master/assets/conduit-name.svg" width="500" height="150">

[![Test Suite](https://github.com/conduit-dart/conduit/actions/workflows/test.yml/badge.svg)](https://github.com/conduit-dart/conduit/actions/workflows/test.yml) [<img src="https://discord.com/assets/3437c10597c1526c3dbd98c737c2bcae.svg" width="28" height="20">](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

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->
12 changes: 6 additions & 6 deletions packages/common/LICENSE
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion packages/common_test/LICENSE
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 0 additions & 2 deletions packages/common_test/lib/conduit_common_test.dart
Original file line number Diff line number Diff line change
@@ -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';
28 changes: 0 additions & 28 deletions packages/conduit/README.md

This file was deleted.

1 change: 1 addition & 0 deletions packages/conduit/README.md
2 changes: 1 addition & 1 deletion packages/test_harness/LICENSE
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 1216ecf

Please sign in to comment.