Skip to content

Commit 668984e

Browse files
alambfindepicomphead
authored
Update documentation guidelines for contribution content (#13703)
* Update documentation guidelines for contribution content * Apply suggestions from code review Co-authored-by: Piotr Findeisen <[email protected]> Co-authored-by: Oleks V <[email protected]> * clarify discussions and remove requirements note * prettier * Update docs/source/contributor-guide/index.md Co-authored-by: Piotr Findeisen <[email protected]> --------- Co-authored-by: Piotr Findeisen <[email protected]> Co-authored-by: Oleks V <[email protected]>
1 parent 5c29399 commit 668984e

File tree

1 file changed

+31
-7
lines changed

1 file changed

+31
-7
lines changed

docs/source/contributor-guide/index.md

+31-7
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ unable to make progress you should unassign the issue by using the `unassign me`
5858
link at the top of the issue page (and ask for help if are stuck) so that
5959
someone else can get involved in the work.
6060

61-
### File Tickets to Discuss New Features
61+
### Discussing New Features
6262

6363
If you plan to work on a new feature that doesn't have an existing ticket, it is
6464
a good idea to open a ticket to discuss the feature. Advanced discussion often
@@ -70,15 +70,39 @@ line PR.
7070
If you open a ticket and it doesn't get any response, you can try `@`-mentioning
7171
recently active community members in the ticket to get their attention.
7272

73-
### What Features are Good Fits for DataFusion?
73+
### What Contributions are Good Fits?
7474

75-
DataFusion is designed to highly extensible, and many features can be implemented
76-
as extensions without changing the core of DataFusion.
75+
DataFusion is designed to be highly extensible, and many features can be
76+
implemented as extensions without changes or additions to the core. Support for
77+
new functions, data formats, and similar functionality can be added using those
78+
extension APIs, and there are already many existing community supported
79+
extensions listed in the [extensions list].
7780

78-
We are [working on criteria for what features are good fits for DataFusion], and
79-
will update this section when we have more to share.
81+
Query engines are complex pieces of software to develop and maintain. Given our
82+
limited maintenance bandwidth, we try to keep the DataFusion core as simple and
83+
focused as possible, while still satisfying the [design goal] of an easy to
84+
start initial experience.
8085

81-
[working on criteria for what features are good fits for datafusion]: https://github.com/apache/datafusion/issues/12357
86+
With that in mind, contributions that meet the following criteria are more likely
87+
to be accepted:
88+
89+
1. Bug fixes for existing features
90+
2. Test coverage for existing features
91+
3. Documentation improvements / examples
92+
4. Performance improvements to existing features (with benchmarks)
93+
5. "Small" functional improvements to existing features (if they don't change existing behavior)
94+
6. Additional APIs for extending DataFusion's capabilities
95+
7. CI improvements
96+
97+
Contributions that will likely involve more discussion (see Discussing New
98+
Features above) prior to acceptance include:
99+
100+
1. Major new functionality (even if it is part of the "standard SQL")
101+
2. New functions, especially if they aren't part of "standard SQL"
102+
3. New data sources (e.g. support for Apache ORC)
103+
104+
[extensions list]: ../library-user-guide/extensions.md
105+
[design goal]: https://docs.rs/datafusion/latest/datafusion/index.html#design-goals
82106

83107
# Developer's guide
84108

0 commit comments

Comments
 (0)