Skip to content

Latest commit

 

History

History
89 lines (65 loc) · 3.07 KB

CONTRIBUTING.md

File metadata and controls

89 lines (65 loc) · 3.07 KB
Raw

Contributing

Contributions to the cloud-storage-etl-udfs project are very welcome!

Please feel free to report a bug, suggest an idea for a feature, or ask a question about the code.

You can create an issue using Github issues or follow a standard fork and pull process to contribute a code via Github pull requests.

Please keep in mind that contributions are not only pull requests. They can be any helpful comment on issues, improving documentation, enhancing build process and many other tasks.

If you do not know where to start, please have a look at open issues. You can choose the ones that interest you the most. If you are new to the project, checkout the issues labeled as good-first-issue.

Building the project

The only prerequisites to build the project are Java and a terminal where you can run some commands.

First clone a local copy of the repository:

git clone https://github.com/exasol/cloud-storage-etl-udfs.git

Then enter into it and run:

./sbtx

From there on you can run several sbt commands. Here are some of them to get you started.

  • clean: cleans previously compiled outputs; to start clean again.
  • compile: compiles the source files.
  • test: run all the unit tests.
  • it:test: run all the integration tests using docker.

Additionally, you can run testOnly filename or it:testOnly filename commands to only run single file tests.

Submit a pull request

Once you have found an interesting feature or issue to contribute, you can follow steps below to submit your patches.

  • Fork the repository,

    git clone [email protected]:YOUR-USERNAME/exasol/cloud-storage-etl-udfs.git

  • Create a new feature branch, git checkout -b "cool-new-feature"

  • Code

  • Write tests for changes

  • Update documentation if needed

  • Make sure everything is working, run ./scripts/ci.sh

  • If everything is okay, commit and push to your fork

  • Submit a pull request

  • Let us work together to get your changes reviewed

  • Merge into master or development branches

If your commit fixes any particular issue, please specify it in your commit message as Fixes issue [issue number]. For example, Fixes issue #29.

Some best practices when creating a pull request:

  • Rebase or update
  • Squash your commits
  • Reword your commits
  • Write clear commit messages

You can read more here and here.