diff --git a/docs/governance/project-annual-review-process.md b/docs/governance/project-annual-review-process.md index 876c96a6..d5278484 100644 --- a/docs/governance/project-annual-review-process.md +++ b/docs/governance/project-annual-review-process.md @@ -34,7 +34,7 @@ If your annual review is not submitted within two months of notification, we wil Your annual review should answer the following questions: -* Include a link to your project’s [LFX Insights page](https://insights-v2.lfx.linuxfoundation.org/projects). We will be looking for signs of consistent or increasing contribution activity. Please feel free to add commentary to add colour to the numbers and graphs we will see on Insights. +* Include information about your project's contributions and activity. We will be looking for signs of consistent or increasing contribution activity. Please feel free to add commentary to add colour to the numbers and graphs we will see on Insights. * How many maintainers do you have, and which organisations are they from? (Feel free to link to an existing MAINTAINERS file if appropriate.) * What do you know about adoption, and how has this changed since your last review or since being accepted into OWF? If you can list companies that are adopters of your project, please do so. (Feel free to link to an existing ADOPTERS file if appropriate. * How has the project performed against its goals since the last review? (We won't penalize you if your goals changed for good reasons.) diff --git a/docs/projects/reviews/0000-template-annual.md b/docs/projects/reviews/0000-template-annual.md index e08e564f..1ddebf2b 100644 --- a/docs/projects/reviews/0000-template-annual.md +++ b/docs/projects/reviews/0000-template-annual.md @@ -1,29 +1,30 @@ +# YYYY PROJECT NAME !!! info Instructions - _Copy this template to the subdirectory for the current year and name the file `YYYY-Project-Name-annual.md` (e.g., `2024-amazingproj-annual.md`). Update the `index.md` file in the current year to include a link to the markdown file. These blocks are instructions. Please remove when section has been completed._ + _Copy this template to the subdirectory for the current year and name the file `YYYY-project-name-annual.md` (e.g., `2024-amazingproj-annual.md`). Update the title above to replace `YYYY` with the year of the annual review and `PROJECT NAME` with the name of the project. Update the `index.md` file in the current year to include a link to the markdown file. These blocks are instructions. Please remove when section has been completed._ -# Project Health +## Project Health !!! info Instructions - _Include a link to your project’s [LFX Insights page](https://insights-v2.lfx.linuxfoundation.org/projects). We will be looking for signs of consistent or increasing contribution activity. Please feel free to add commentary to add color to the numbers and graphs we will see on Insights._ + _Include information about your project's contributions and activity. You can find information within GitHub by looking at the Insights tab. We will be looking for signs of consistent or increasing contribution activity. Please feel free to add commentary to add color to this information._ -# Maintainer Diversity +## Maintainer Diversity !!! info Instructions _How many maintainers do you have, and which organisations are they from? How has the maintainers and diversity of your maintainers changed in the past year? Has the number of active maintainers increased/decreased? Has the diversity of maintainers increased/decreased? Please include a link to your existing MAINTAINERS file and the MAINTAINERS file from last year (if appropriate). This is a good opportunity to ensure that your MAINTAINERS file is up to date and to retire any maintainers._ -# Project Adoption +## Project Adoption !!! info Instructions _What do you know about adoption, and how has this changed since your last review or since being accepted into OpenWallet Foundation? If you can list companies that are adopters of your project, please do so. Feel free to link to an existing ADOPTERS file if appropriate._ -# Goals +## Goals -## Performance Against Prior Goals +### Performance Against Prior Goals !!! info Instructions _Include information about the goals that you previously set for the project in the last review or since the project proposal has been approved. How has the project performed against these goals? If your goals changed from your previous annual report, let us know what changed and why. If you have not achieved the goals that you set out, that is okay. We want to know what you have accomplished and what challenges the project is having in meeting the goals._ -## Next Year's Goals +### Next Year's Goals !!! info Instructions _What are the goals for the next year of the project? The goals should list what you want to achieve, not just what you know you can achieve. Feel free to include stretch goals and things that you are looking to explore in the next year. For example, are you working on major new features? Or are you concentrating on adoption, community growth, or documentation?_ @@ -33,7 +34,7 @@ !!! info Instructions _How can the OpenWallet Foundation or the TAC help you achieve your upcoming goals?_ -# Project Lifecycle Stage Recommendation +## Project Lifecycle Stage Recommendation !!! info Instructions - _What stage do you think the project should be? If you you think that your project meets the criteria for another stage, please explain why. + _What stage do you think the project should be? If you you think that your project meets the criteria for another stage, please explain why._