diff options
author | vitalyisaev <vitalyisaev@ydb.tech> | 2023-11-30 13:26:22 +0300 |
---|---|---|
committer | vitalyisaev <vitalyisaev@ydb.tech> | 2023-11-30 15:44:45 +0300 |
commit | 0a98fece5a9b54f16afeb3a94b3eb3105e9c3962 (patch) | |
tree | 291d72dbd7e9865399f668c84d11ed86fb190bbf /contrib/libs/antlr4_cpp_runtime/CONTRIBUTING.md | |
parent | cb2c8d75065e5b3c47094067cb4aa407d4813298 (diff) | |
download | ydb-0a98fece5a9b54f16afeb3a94b3eb3105e9c3962.tar.gz |
YQ Connector:Use docker-compose in integrational tests
Diffstat (limited to 'contrib/libs/antlr4_cpp_runtime/CONTRIBUTING.md')
-rw-r--r-- | contrib/libs/antlr4_cpp_runtime/CONTRIBUTING.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/contrib/libs/antlr4_cpp_runtime/CONTRIBUTING.md b/contrib/libs/antlr4_cpp_runtime/CONTRIBUTING.md new file mode 100644 index 0000000000..0a2317bab3 --- /dev/null +++ b/contrib/libs/antlr4_cpp_runtime/CONTRIBUTING.md @@ -0,0 +1,22 @@ +# Contributing to ANTLR 4 + +1. [Fork](https://help.github.com/articles/fork-a-repo) the [antlr/antlr4 repo](https://github.com/antlr/antlr4), which will give you both key branches, `master` and `dev` +2. Make sure to `git checkout dev` in your fork so that you are working from the latest development branch +3. Create and work from a branch derived from `dev` such as `git checkout -b your-branch-name` +4. Install and configure [EditorConfig](http://editorconfig.org/) so your text editor or IDE uses the ANTLR 4 coding style +5. [Build ANTLR 4](doc/building-antlr.md) +6. [Run the ANTLR project unit tests](doc/antlr-project-testing.md) +7. Create a [pull request](https://help.github.com/articles/using-pull-requests/) with your changes and make sure you're comparing your `dev`-derived branch in your fork to the `dev` branch from the `antlr/antlr4` repo: + +<img src="doc/images/PR-on-dev.png" width="600"> + +**Note:** Each commit requires a "signature", which is simple as using `-s` (not +`-S`) to the git commit command: + +``` +git commit -s -m 'This is my commit message' +``` + +Github's pull request process enforces the sig and gives instructions on how to +fix any commits that lack the sig. See [Github DCO app](https://github.com/apps/dco) +for more info. |