You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+28-10
Original file line number
Diff line number
Diff line change
@@ -9,43 +9,61 @@ easy and transparent as possible, whether it's:
9
9
- Proposing new features
10
10
11
11
## We develop with Github
12
+
12
13
We use github to host code, to track issues and feature requests, as well as accept pull requests.
13
14
15
+
## Finding tasks to work on
16
+
17
+
When the core SQLGlot team does not plan to work on an issue, it is usually closed as "not planned". This may happen
18
+
when a request is exceptionally difficult to address, or because the team deems that it shouldn't be prioritized.
19
+
20
+
These issues can be a good starting point when looking for tasks to work on. Simply filter the issue list to fetch
21
+
the closed issues and then search for those marked as "not planned". If the scope of an issue is not clear or you
22
+
need guidance, feel free to ask for clarifications.
23
+
24
+
Before taking on a task, consider studying the [AST primer](https://github.com/tobymao/sqlglot/blob/main/posts/ast_primer.md) and the [onboarding document](https://github.com/tobymao/sqlglot/blob/main/posts/onboarding.md).
25
+
14
26
## Submitting code changes
15
-
Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:
16
27
17
-
Please keep PR's small and do your best to follow the conventions of the project. If you have a feature that requires a lot of code changes,
18
-
please reach out to us on [Slack](https://tobikodata.com/slack) before making a PR. This will increase the chances of your PR getting in.
28
+
Pull requests are the best way to propose changes to the codebase, and we actively welcome them.
19
29
20
-
1. Fork the repo and create your branch from `main`.
21
-
2. If you've added code that should be tested, add tests.
22
-
3. If you've changed APIs, update the documentation.
23
-
4. Ensure the test suite & linter [checks](https://github.com/tobymao/sqlglot/blob/main/README.md#run-tests-and-lint) pass.
24
-
5. Issue that pull request and wait for it to be reviewed by a maintainer or contributor!
30
+
Pull requests should be small and they need to follow the conventions of the project. For features that require
31
+
many changes, please reach out to us on [Slack](https://tobikodata.com/slack) before making a request, in order
32
+
to share any relevant context and increase its chances of getting merged.
33
+
34
+
1. Fork the repo and create your branch from `main`
35
+
2. If you've added code with non-trivial changes, add tests
36
+
3. If you've changed APIs, update the documentation (docstrings)
37
+
4. Ensure the test suite & linter [checks](https://github.com/tobymao/sqlglot/blob/main/README.md#run-tests-and-lint) pass
38
+
5. Issue that pull request and wait for it to be reviewed by a maintainer or contributor
25
39
26
40
Note: make sure to follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) guidelines when creating a PR.
27
41
28
42
## Report bugs using Github's [issues](https://github.com/tobymao/sqlglot/issues)
43
+
29
44
We use GitHub issues to track public bugs. Report a bug by opening a new issue.
30
45
31
46
**Great Bug Reports** tend to have:
32
47
33
48
- A quick summary and/or background
34
49
- Steps to reproduce
35
-
- Be specific!
50
+
- Be specific
36
51
- Give sample code if you can
37
52
- What you expected would happen
38
53
- What actually happens
39
54
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
40
55
- References (e.g. documentation pages related to the issue)
41
56
42
57
## Start a discussion using Github's [discussions](https://github.com/tobymao/sqlglot/discussions)
58
+
43
59
[We use GitHub discussions](https://github.com/tobymao/sqlglot/discussions/190) to discuss about the current state
44
-
of the code. If you want to propose a new feature, this is the right place to do it! Just start a discussion, and
60
+
of the code. If you want to propose a new feature, this is the right place to do it. Just start a discussion, and
45
61
let us know why you think this feature would be a good addition to SQLGlot (by possibly including some usage examples).
0 commit comments