Skip to content

Commit

Permalink
remove ditrit and badaas
Browse files Browse the repository at this point in the history
  • Loading branch information
FrancoLiberali committed Dec 19, 2023
1 parent 08ecf20 commit d6c895f
Show file tree
Hide file tree
Showing 109 changed files with 340 additions and 884 deletions.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ If applicable, add screenshots to help explain your problem.

Please complete the following information:

- badaas version [X.X.X] or commit hash
- cql version [X.X.X] or commit hash
- go version
- database vendor and version (in case of bugs related with badaas-orm)
- database vendor and version

## Additional context

Expand Down
5 changes: 2 additions & 3 deletions .github/ISSUE_TEMPLATE/discussion.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
name: Discussion
about: Start a discussion for BaDaaS
about: Start a discussion for cql
title: ''
labels: question
---
<!-- Please join the DitRit discord server https://discord.gg/zkKfj9gj2C to ask questions and troubleshoot (use the BADAAS channel). For all other design discussions please continue. -->
---
5 changes: 0 additions & 5 deletions .github/pull_request_template.md

This file was deleted.

2 changes: 1 addition & 1 deletion .github/workflows/cql.yml
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ jobs:
path: coverage_${{ matrix.db }}.out
- name: Stop containers
if: ${{ matrix.db != 'sqlite' }}
run: docker stop badaas-test-db
run: docker stop cql-test-db

sonarcloud:
name: SonarCloud
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,4 @@ docs/_build/
# cli
cql-cli/cql-cli
cql-cli/cmd/gen/conditions/*_conditions.go
cql-cli/cmd/gen/conditions/tests/**/badaas-orm.go
cql-cli/cmd/gen/conditions/tests/**/cql.go
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ representative at an online or offline event.

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
<[email protected]>.
<[email protected]>.
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ lint:
cd cql-cli && golangci-lint run --config ../.golangci.yml

rmdb:
docker stop badaas-test-db && docker rm badaas-test-db
docker stop cql-test-db && docker rm cql-test-db

postgresql:
docker compose -f "docker/postgresql/docker-compose.yml" up -d
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# BaDaaS ORM: Backend and Distribution ORM (Object Relational Mapping) <!-- omit in toc -->
# CQL: Compiled Query Language <!-- omit in toc -->

Badaas-orm is the BaDaaS' component that allows for easy and safe persistence and querying of objects but it can be used both within a BaDaaS application and independently.
CQL allows easy and safe persistence and querying of objects.

It's built on top of `gorm <https://gorm.io/>`_, a library that actually provides the functionality of an ORM: mapping objects to tables in the SQL database. While gorm does this job well with its automatic migration then performing queries on these objects is somewhat limited, forcing us to write SQL queries directly when they are complex. Badaas-orm seeks to address these limitations with a query system that:
It's built on top of `gorm <https://gorm.io/>`_, a library that actually provides the functionality of an ORM: mapping objects to tables in the SQL database. While gorm does this job well with its automatic migration then performing queries on these objects is somewhat limited, forcing us to write SQL queries directly when they are complex. CQL seeks to address these limitations with a query system that:

- Is compile-time safe: its query system is validated at compile time to avoid errors such as comparing attributes that are of different types, trying to use attributes or navigate relationships that do not exist, using information from tables that are not included in the query, etc.
- Is easy to use: the use of this system does not require knowledge of databases, SQL languages or complex concepts. Writing queries only requires programming in go and the result is easy to read.
Expand All @@ -16,8 +16,8 @@ It's built on top of `gorm <https://gorm.io/>`_, a library that actually provide

## Contributing

See [this section](../docs/contributing/contributing.md) to view the badaas contribution guidelines.
See [this section](../docs/contributing/contributing.md) to view the cql contribution guidelines.

## License

Badaas is Licensed under the [Mozilla Public License Version 2.0](../LICENSE).
CQL is Licensed under the [Mozilla Public License Version 2.0](../LICENSE).
18 changes: 0 additions & 18 deletions changelog.md

This file was deleted.

55 changes: 6 additions & 49 deletions cql-cli/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,20 @@
# Contribute to the development of badaas
# Contribute to the development of cql-cli <!-- omit in toc -->

- [Contribute to the development of badaas](#contribute-to-the-development-of-badaas)
- [Local compilation](#local-compilation)
- [Tests](#tests)
- [Git](#git)
- [Branch naming policy](#branch-naming-policy)
- [Default branch](#default-branch)
- [How to release](#how-to-release)
- [Local compilation](#local-compilation)
- [Tests](#tests)

## Local compilation

You can make modifications to the badaas-cli source code and compile it locally with:
You can make modifications to the cql-cli source code and compile it locally with:

```bash
go build .
```

You can then run the badaas-cli executable directly or add a link in your $GOPATH to run it from a project:
You can then run the cql-cli executable directly or add a link in your $GOPATH to run it from a project:

```bash
ln -sf badaas-cli $GOPATH/bin/badaas-cli
ln -sf cql-cli $GOPATH/bin/cql-cli
```

## Tests
Expand All @@ -31,41 +26,3 @@ To run them, please run:
```sh
make test
```

## Git

### Branch naming policy

`[BRANCH_TYPE]/[BRANCH_NAME]`

- `BRANCH_TYPE` is a prefix to describe the purpose of the branch.
Accepted prefixes are:
- `feature`, used for feature development
- `bugfix`, used for bug fix
- `improvement`, used for refactor
- `library`, used for updating library
- `prerelease`, used for preparing the branch for the release
- `release`, used for releasing project
- `hotfix`, used for applying a hotfix on main
- `poc`, used for proof of concept
- `BRANCH_NAME` is managed by this regex: `[a-z0-9._-]` (`_` is used as space character).

### Default branch

The default branch is `main`. Direct commit on it is forbidden. The only way to update the application is through pull request.

Release tag are only done on the `main` branch.

### How to release

We use [Semantic Versioning](https://semver.org/spec/v2.0.0.html) as guideline for the version management.

Steps to release:

- Create a new branch labeled `release/vX.Y.Z` from the latest `main`.
- Improve the version number in `changelog.md`.
- Verify the content of the `changelog.md`.
- Commit the modifications with the label `Release version X.Y.Z`.
- Create a pull request on github for this branch into `main`.
- Once the pull request validated and merged, tag the `main` branch with `vX.Y.Z`.
- After the tag is pushed, make the release on the tag in GitHub.
Loading

0 comments on commit d6c895f

Please sign in to comment.