Skip to content

Commit

Permalink
add version upgrade information
Browse files Browse the repository at this point in the history
  • Loading branch information
sdirix committed Apr 18, 2024
1 parent 4d2dfb1 commit 539ff2f
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,21 @@ The better the quality of the contribution, the faster it can be merged.
If you have an idea for a feature, we recommend first opening an issue or starting a discussion on the [Community Board](https://jsonforms.discourse.group) to assess whether it aligns with the goals and scope of JSON Forms.
We aim to keep the core framework lean and clean, focusing on features that provide the most value.

### Contributing Version Upgrades

Generally speaking we always aim to support the latest version of any dependency we use.
In the same vain, we try to not raise the lower bound of any (peer) dependency declaration if it does not require substantial additional effort.

For the seed applications we usually aim to use the latest version of any dependency available.
This serves as a testing ground that JSON Forms is in fact compatible to them when consumed in a regular manner.

Therefore when contributing, please take a look at the following suggestions:

- Only raise the lower bound of (peer) dependencies if it is required or substantial effort to not do so
- The upper bound should ideally include the latest available stable version
- Test the new JSON Forms version in the respective seed application, with and without updating the corresponding dependencies.
- For this you can use tools like [yalc](https://github.com/wclr/yalc).

## Repositories

You can contribute to any of the following repositories:
Expand Down

0 comments on commit 539ff2f

Please sign in to comment.