Skip to content

Commit 4946ca1

Browse files
committed
Improve CONTRIBUTING
1 parent 08f8827 commit 4946ca1

File tree

1 file changed

+54
-7
lines changed

1 file changed

+54
-7
lines changed

CONTRIBUTING.md

Lines changed: 54 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,46 @@
1-
# Contributing to Spark Dialect Extension
1+
# Contributing Guide
22

3-
This document provides detailed steps to build the Spark Dialect Extension from the source code.
3+
Welcome! There are many ways to contribute, including submitting bug
4+
reports, improving documentation, submitting feature requests, reviewing
5+
new submissions, or contributing code that can be incorporated into the
6+
project.
47

5-
### Prerequisites
8+
## Review process
9+
10+
For any **significant** changes please create a new GitHub issue and
11+
enhancements that you wish to make. Describe the feature you would like
12+
to see, why you need it, and how it will work. Discuss your ideas
13+
transparently and get community feedback before proceeding.
14+
15+
Small changes can directly be crafted and submitted to the GitHub
16+
Repository as a Pull Request. This requires creating a **repo fork** using
17+
[instruction](https://docs.github.com/en/get-started/quickstart/fork-a-repo).
18+
19+
## Initial setup for local development
20+
21+
### Install Git
22+
23+
Please follow
24+
[instruction](https://docs.github.com/en/get-started/quickstart/set-up-git).
25+
26+
### Clone the repo
27+
28+
Open terminal and run these commands:
29+
30+
```bash
31+
git clone git@github.com:myuser/spark-dialect-extension.git
32+
33+
cd spark-dialect-extension
34+
```
35+
36+
### Setup environment
637

738
Before you start, ensure you have the following installed:
839
- **Java**: Java 8 or higher. [Java Installation Guide](https://adoptopenjdk.net/)
940
- **Gradle**: [Gradle Installation Guide](https://docs.gradle.org/current/userguide/installation.html)
1041

42+
# How to
43+
1144
### Compile the Project
1245

1346
To compile the project and generate a JAR file, run the following command in the project's root directory:
@@ -18,8 +51,7 @@ To compile the project and generate a JAR file, run the following command in the
1851

1952
This command compiles the source code and packages it into a .jar files located in the ``build/libs`` directory.
2053

21-
22-
## Running Scala Tests
54+
## Run Scala Tests
2355

2456
This section describes how to run Scala tests for the Spark Dialect Extension.
2557

@@ -48,7 +80,7 @@ After completing the tests, you can stop the Docker containers with:
4880
docker-compose -f docker-compose.test.yml down
4981
```
5082

51-
## Code Formatting and Linting
83+
## Format and lint the code
5284

5385
### Using Scalafmt to Format Code
5486

@@ -65,9 +97,24 @@ To lint and refactor the code, run Scalafix using the following command:
6597
```
6698
This command checks the code against various rules specified in the ```.scalafix.conf``` file and applies fixes where possible.
6799

100+
## Create a pull request
101+
102+
Commit your changes:
103+
104+
```bash
105+
git commit -m "Commit message"
106+
git push
107+
```
108+
109+
Then open Github interface and [create pull request](https://docs.github.com/en/get-started/quickstart/contributing-to-projects#making-a-pull-request).
110+
Please follow guide from PR body template.
111+
112+
After pull request is created, it get a corresponding number, e.g. 123
113+
(`pr_number`).
68114

69-
## Release process
115+
## Release a new package version
70116

117+
Note: this is only for repo maintainers
71118

72119
1. Checkout to ``develop`` branch and update it to the actual state
73120

0 commit comments

Comments
 (0)