Skip to content

Commit

Permalink
Update README with enhanced information and communication channels
Browse files Browse the repository at this point in the history
Enhanced the README file by adding detailed maintenance policies for the
`meta-freescale` layer, including information about branch management
and release cycles.

Additionally, included specifics about the maintained branches such as
`master`, `scarthgap`, `nanbield`, and `kirkstone`. This update aims to
provide users with a clearer understanding of the project's maintenance
practices and available branches.

Signed-off-by: Otavio Salvador <[email protected]>
  • Loading branch information
otavio committed Apr 10, 2024
1 parent 1689628 commit 73bd34e
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 34 deletions.
34 changes: 0 additions & 34 deletions README

This file was deleted.

47 changes: 47 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# OpenEmbedded/Yocto Project BSP Layer for NXP's Platforms

Welcome to `meta-freescale`. This document outlines our commitment to providing consistent support and updates in alignment with the Yocto Project LTS release schedule.

This layer provides support for NXP's platforms for use with OpenEmbedded and/or Yocto Project.

### Dependencies

This layer depends on:

- URI: git://git.openembedded.org/openembedded-core
- Branch: master
- Revision: HEAD

## Branches

- **master:** This is our primary development branch, receiving continuous bug fixes and BSP upgrades. It represents the latest and greatest version, ensuring compatibility with the most recent Yocto Project release.
- **scarthgap:** Associated with Yocto Project 5.0 (LTS), maintained until April 2028 for bug fixes and until April 2026 for BSP backports.
- **nanbield:** Corresponding to Yocto Project 4.3, it's maintained until May 2024 for bug fixes and BSP backports.
- **kirkstone:** Tied to Yocto Project 4.0 (LTS), supported until April 2026 for bug fixes and until April 2024 for BSP backports.

## Maintenance Policy

- **Latest and Greatest (Master):** Continuous attention to bug fixes and BSP upgrades, ensuring that our users have access to the latest enhancements and improvements.
- **Stable Releases:** Each stable release is maintained until the subsequent version is released. This includes backports for BSP and critical bug fixes, along with updates for security vulnerabilities (CVEs).
- **Long-Term Support (LTS) Releases:** These are maintained for the duration of Yocto Project's LTS support. We prioritize bug fixes, security vulnerabilities (CVEs) updates, and BSP backports to ensure stability and reliability.

This policy ensures that our users can rely on consistent support and updates, backed by our commitment to delivering high-quality BSP layers.

## Release Cycle

- **Yocto Project LTS Releases:** Our LTS branches follow the [Yocto Project LTS release schedule](https://wiki.yoctoproject.org/wiki/Releases), which involves a four-year maintenance period. A new LTS version is typically released every two years.
- **Stable Releases:** We aim to provide stable releases every six months, aligning with the pace of Yocto Project's stable releases.

## Contributing

Please submit any patches against the `meta-freescale` layer by using the GitHub pull-request feature. Fork the repo, create a branch, do the work, rebase from upstream, and then create the pull request.

For useful guidelines on submitting patches, please refer to the [Commit Patch Message Guidelines](http://openembedded.org/wiki/Commit_Patch_Message_Guidelines).

Pull requests will be discussed within the GitHub pull-request infrastructure. If you want to stay informed about new PRs and follow-up discussions, please use GitHub's notification system. Additionally, feel free to open GitHub issues for bug reports, feature requests, or general discussions.

## Communication

- **GitHub Issues:** [meta-freescale issues](https://github.com/Freescale/meta-freescale/issues)
- **GitHub Discussions:** [meta-freescale discussions](https://github.com/Freescale/meta-freescale/discussions)
- **Pull Requests:** [meta-freescale pull requests](https://github.com/Freescale/meta-freescale/pulls)

0 comments on commit 73bd34e

Please sign in to comment.