Skip to content

Commit

Permalink
docs(changeset, readme): update changeset instructions and improve re…
Browse files Browse the repository at this point in the history
…adme

The changeset README has been updated with detailed instructions on how to write a changeset, including examples and guidelines for choosing version tags.

The main project README has been improved with a better overview of the Fusion Framework, sections on getting started, cookbooks, and contributing. This provides more context and guidance for new users and contributors.
  • Loading branch information
odinr committed May 13, 2024
1 parent 962d71e commit 7b772e5
Show file tree
Hide file tree
Showing 2 changed files with 77 additions and 9 deletions.
53 changes: 48 additions & 5 deletions .changeset/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,51 @@
# Changesets

Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
with multi-package repos, or single-package repos to help you version and publish your code. You can
find the full documentation for it [in our repository](https://github.com/changesets/changesets)
## What is this?

We have a quick list of common questions to get you started engaging with this project in
[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)
Changesets is a tool for managing and versioning code changes.
It helps keep track of what changed between releases to make changelogs and auto-generated release notes.
You can find the full documentation for it [in our repository](https://github.com/changesets/changesets).

## How to write a changeset

1. Create a new file in the `.changesets` folder with the name of the package you want to change (use random human readable names by default for these files to avoid collisions when generating them. e.g., `happy-sock-monster.md`).
2. Add all affected packages to markdown metadata (front matter) using the format "PACKAGE_NAME": VERSION_TAG (e.g., `"@equinor/fusion-query": patch`).
3. Write a brief description of the change(s).
4. Add sections for each package that was changed.
5. Explain in detailed why and what changes made to the package.
6. Explain in detail how a consumer should update their code
7. [optional] Include code blocks with examples of how to use new features or migrate breaking changes.
8. [optional] Include mermaid diagrams to illustrate the flow of the change.


**When deciding on a version tag, consider:**

* `major` version when making incompatible library changes
* `minor` version when adding functionality in a backward compatible manner
* `patch` version when making backward compatible bug fixes

## Example

```md
---
"@equinor/fusion-query": patch
"@equinor/fusion-react": minor
---

## @equinor/fusion-query

Changed functionality of `Query.query` to accept a new argument `invalidate`.

## @equinor/fusion-react
Added a new feature...
```


FROM starcoder2
SYSTEM """
You are a software engineer at Fusion a Equinor project.
You are highly skilled in Typescript, RxJs and React.
You assist your colleagues in writing code and documentation.
Do not make assumptions or fabricating additional details.
When explaining, give good examples with well documented code, also inline code.
"""
33 changes: 29 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,33 @@
# Fusion Framework

## 📚 read the [Doc](https://equinor.github.io/fusion-framework/)
## 🚀 see the [Road Map](https://equinor.github.io/fusion-framework/roadmap)
## 👨🏻‍🍳 see our [Cookboks](https://github.com/equinor/fusion-framework/tree/main/cookbooks)
Fusion Framework is a modular and extensible framework designed to simplify the development of modern web applications. It provides a set of core modules and utilities that handle common concerns like authentication, HTTP communication, service discovery, and event handling. The framework is built with flexibility in mind, allowing developers to easily configure and extend its functionality to meet their application's needs.

## 🚀 Get Started

## 👋 [Contribute?](./CONTRIBUTING.md)
The best place to start is by reading through the [documentation](https://equinor.github.io/fusion-framework/) on the core concepts and architecture. The framework is modular, so you can pick and choose which parts to use.

If you're developing an application for the Fusion Portals, check out the [Fusion Docs](https://fusion-docs.fusion-dev.net/docs/i-want-to-create/application/getting-started) for specific requirements and setup.

## 👨🏻‍🍳 Cookbooks

The [cookbooks](https://github.com/equinor/fusion-framework/tree/main/cookbooks) directory contains sample applications demonstrating how to implement various features and patterns using the framework. These runnable examples cover topics like:

- Setting up a basic React application
- Integrating routing and navigation
- Managing application state
- Enabling authentication and authorization
- Consuming APIs and services
- Implementing feature flags
- And more!

The cookbooks are well-commented and can serve as a starting point or reference for your own applications.

## 👋 Contribute

The Fusion Framework is open-source, and we welcome contributions from the developer community. Whether you're fixing a bug, adding a new feature, improving the documentation, or creating a new cookbook, your contributions can help make the framework even better.

Check out the [Contributing Guide](./CONTRIBUTING.md) for the process of opening issues, submitting pull requests, code style guidelines, and more.

We appreciate all contributions, no matter how big or small. Every bug fix, feature addition, documentation improvement, or new cookbook helps make the Fusion Framework better for everyone.

If you have any questions or need help getting started with contributing, don't hesitate to reach out to the maintainers or join the project's community channels.

0 comments on commit 7b772e5

Please sign in to comment.