Skip to content

Commit

Permalink
Add contributing information to README
Browse files Browse the repository at this point in the history
  • Loading branch information
linusha committed Jul 31, 2023
1 parent a45ea9b commit d097d08
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 2 deletions.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,28 @@

A repository to collect and share components in lively.next.

## About

This is an homage to the `PartsBin`, as included in various versions of `lively`. Since `lively.next` emphasizes collaborative work via file-based projects, we utilize such a project as well to share reusable parts and cool demos with the whole `lively.next` community!

> **Note**
> You are welcome to contribute to this collection! Please read the section below.
> Have fun! 🎉
## Contributing

Contributions can be made via a PR to the `main` branch. Please make sure to:

0. Note, that the whole collection is under MIT license.
1. Add a short description of your addition to the README below.
2. Store the `partsbin` project via `lively.next` (or make the necessary adaptions manually, if you know what you are doing) in order to update all `lively.project` related files.
3. Bump the minor version for additions/fixes. Bump only the patch version for non-breaking/not fixing changes.

> **Warning**
> **Note to Maintainers: We try to merge PRs that introduce a new part via *one* merge commit.
> Fixes to already merged parts should usually be merged via rebase.

## Contents

### Clock
Expand All @@ -19,4 +41,7 @@ A thermometer which can be used as an alternative GUI for number-widgets.
### Temperature Converter

A simple demo application converting Celsius in Fahrenheit, which provides two alternative front-ends, demonstrating the reuse of `ViewModel`s.


## License

MIT. (c) The `lively.next` community 2023 onwards.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,5 @@
"projectDependencies": [],
"boundLivelyVersion": "34f27b39a9805265b86369a67ee0ffe665dc1f8e"
},
"version": "0.6.2"
"version": "0.6.3"
}

0 comments on commit d097d08

Please sign in to comment.