Skip to content

Commit 858c5b1

Browse files
authored
Chore: improve contribution guide (#4379)
1 parent a3af2af commit 858c5b1

File tree

1 file changed

+28
-10
lines changed

1 file changed

+28
-10
lines changed

CONTRIBUTING.md

+28-10
Original file line numberDiff line numberDiff line change
@@ -9,43 +9,61 @@ easy and transparent as possible, whether it's:
99
- Proposing new features
1010

1111
## We develop with Github
12+
1213
We use github to host code, to track issues and feature requests, as well as accept pull requests.
1314

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+
1426
## Submitting code changes
15-
Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:
1627

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.
1929

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
2539

2640
Note: make sure to follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) guidelines when creating a PR.
2741

2842
## Report bugs using Github's [issues](https://github.com/tobymao/sqlglot/issues)
43+
2944
We use GitHub issues to track public bugs. Report a bug by opening a new issue.
3045

3146
**Great Bug Reports** tend to have:
3247

3348
- A quick summary and/or background
3449
- Steps to reproduce
35-
- Be specific!
50+
- Be specific
3651
- Give sample code if you can
3752
- What you expected would happen
3853
- What actually happens
3954
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
4055
- References (e.g. documentation pages related to the issue)
4156

4257
## Start a discussion using Github's [discussions](https://github.com/tobymao/sqlglot/discussions)
58+
4359
[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
4561
let us know why you think this feature would be a good addition to SQLGlot (by possibly including some usage examples).
4662

4763
## [License](https://github.com/tobymao/sqlglot/blob/main/LICENSE)
64+
4865
By contributing, you agree that your contributions will be licensed under its MIT License.
4966

5067
## References
68+
5169
This document was adapted from [briandk's template](https://gist.github.com/briandk/3d2e8b3ec8daf5a27a62).

0 commit comments

Comments
 (0)