mirror of
https://github.com/ent/ent.git
synced 2026-05-24 09:31:56 +03:00
b0e889a997
Summary: Pull Request resolved: https://github.com/facebookincubator/ent/pull/68 Closes #62 Reviewed By: alexsn Differential Revision: D17782435 fbshipit-source-id: c2995dbf2c1cbdb032cf4c2865769ffa7a3214ad
75 lines
2.6 KiB
Markdown
75 lines
2.6 KiB
Markdown
# Contributing to ent
|
|
We want to make contributing to this project as easy and transparent as
|
|
possible.
|
|
|
|
# Project structure
|
|
|
|
- `dialect` - Contains SQL and Gremlin code used by the generated code.
|
|
- `dialect/sql/schema` - Auto migration logic resides there.
|
|
|
|
- `schema` - User schema API.
|
|
- `schema/{field, edge, index}` - provides schema builders API.
|
|
- `schema/field/gen` - Templates and codegen for numeric builders.
|
|
|
|
- `entc` - Codegen of `ent`.
|
|
- `entc/load` - `entc` loader API for loading user schemas into a Go objects at runtime.
|
|
- `entc/gen` - The actual code generation logic resides in this package (and its `templates` package).
|
|
- `integration` - Integration tests for `entc`.
|
|
|
|
- `doc` - Documentation code for `entgo.io` (uses [Docusaurus](https://docusaurus.io)).
|
|
- `doc/md` - Markdown files for documentation.
|
|
- `doc/website` - Website code and assets.
|
|
|
|
# Working on `entc`
|
|
|
|
If you work on one of the template files (`gen/templates`, `load/templates`, `load/schema.go`), you should
|
|
run `go-bindata`, in order to embedded these files in `entc` binary. Please install it by running the following
|
|
command in your `$HOME` directory.
|
|
|
|
```
|
|
go get -u github.com/go-bindata/go-bindata
|
|
```
|
|
|
|
# Run integration tests
|
|
If you touch any file in `entc`, run the following command in `entc/integration`:
|
|
|
|
```
|
|
go generate ./...
|
|
```
|
|
|
|
Then, run `docker-compose` in order to spin-up all database containers:
|
|
|
|
```
|
|
docker-compose -f compose/docker-compose.yaml up -d --scale test=0
|
|
```
|
|
|
|
Then, run `go test ./...` to run all integration tests.
|
|
|
|
|
|
## Pull Requests
|
|
We actively welcome your pull requests.
|
|
|
|
1. Fork the repo and create your branch from `master`.
|
|
2. If you've added code that should be tested, add tests.
|
|
3. If you've changed APIs, update the documentation.
|
|
4. Ensure the test suite passes.
|
|
5. Make sure your code lints.
|
|
6. If you haven't already, complete the Contributor License Agreement ("CLA").
|
|
|
|
## Contributor License Agreement ("CLA")
|
|
In order to accept your pull request, we need you to submit a CLA. You only need
|
|
to do this once to work on any of Facebook's open source projects.
|
|
|
|
Complete your CLA here: <https://code.facebook.com/cla>
|
|
|
|
## Issues
|
|
We use GitHub issues to track public bugs. Please ensure your description is
|
|
clear and has sufficient instructions to be able to reproduce the issue.
|
|
|
|
Facebook has a [bounty program](https://www.facebook.com/whitehat/) for the safe
|
|
disclosure of security bugs. In those cases, please go through the process
|
|
outlined on that page and do not file a public issue.
|
|
|
|
## License
|
|
By contributing to ent, you agree that your contributions will be licensed
|
|
under the LICENSE file in the root directory of this source tree. |