Skip to content

Commit

Permalink
doc: add submodule policy in CONTRIBUTING.md (#4930)
Browse files Browse the repository at this point in the history
Co-authored-by: Simon Larsén <slarse@slar.se>
  • Loading branch information
monperrus and slarse committed Oct 9, 2022
1 parent 539322b commit 999e4dd
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,3 +83,22 @@ The public API is composed of all public classes and methods, except those for w
* located in a package called `internal`, including all subpackages, that is `**.internal.**`

Classes annotated with `@Experimental` are planned to in the public API in the future, but are still considered unstable and can change in non-backward compatble manner.

Submodule Policy
----------

By default, we favor adding new functionalities in spoon-core, in order to have the easiest possible integration for clients. We commit to maintain the code in spoon-core.

We create submodules when

1) the functionality would bloat the spoon-core binary too much

OR

2) the functionality is too experimental / too unstable to meet the high quality standard of spoon-core

OR

3) the integrator team welcomes the contribution, but cannot commit to maintaining it.

Submodules are not published to Maven central, and so need to be built from source.

0 comments on commit 999e4dd

Please sign in to comment.