Skip to content

Commit d01336d

Browse files
Release documents
1 parent febc813 commit d01336d

File tree

14 files changed

+230
-91
lines changed

14 files changed

+230
-91
lines changed

.github/CODEOWNERS

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# This repository is maintained by:
2+
* @phazonoverload @ashleywolf

.github/workflows/dependabot.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: 'github-actions'
4+
directory: '/'
5+
schedule:
6+
interval: 'weekly'

CONTRIBUTING.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
## Contributing
2+
3+
[fork]: https://github.com/github-samples/models-in-actions/fork
4+
[pr]: https://github.com/github-samples/models-in-actions/compare
5+
6+
Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
7+
8+
Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](LICENSE).
9+
10+
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
11+
12+
## Submitting a pull request
13+
14+
1. [Fork][fork] and clone the repository
15+
1. Add your workflows to the `workflows` directory. Each action should be in its own subdirectory, and the name of the subdirectory should match the name of the action.
16+
1. Make sure your workflow file has setup instruction at the top of it in comments.
17+
1. Make sure to add a `README.md` file in the action's subdirectory. This file should describe what the action does, how to use it, and any inputs or outputs it has.
18+
1. Make sure to add your action to the `README.md` file in the root of the repository. This file should list all the actions in the repository and provide a brief description of each one.
19+
1. Push to your fork and [submit a pull request][pr]
20+
1. Pat yourself on the back and wait for your pull request to be reviewed and merged.
21+
22+
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
23+
24+
- Show what the output of the workflow looks like. If you can, include a screenshot or a link to a run of the workflow in your pull request description.
25+
- Only submit one workflow per pull request. This makes it easier for us to review and merge your changes.
26+
- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
27+
28+
## Resources
29+
30+
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
31+
- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
32+
- [GitHub Help](https://help.github.com)

README.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,20 @@
1-
# Walkthrough Template
1+
# GitHub Models in GitHub Actions
22

3-
This repository serves as a template for creating a walkthrough. Follow the steps below to get started.
3+
This repository contains a collection of [GitHub Actions](https://github.com/features/actions) workflows that utilize [GitHub Models](https://docs.github.com/en/github-models) to automate various tasks with AI.
44

5-
## Getting Started
5+
| Title | Description | Author |
6+
| [Weekly Issue Summary](/workflows/weekly-issue-summary/weekly-issue-summary.yml) | Opens a new issue weekly summarizing the issues created in the last week. | @phazonoverload |
7+
| [Bug Reproduction Check](/workflows/bug-reproduction-check/bug-reproduction-check.yml) | Comments with request for better reproduction details, if needed. | @phazonoverload |
8+
| [Add Merged PR to Changelog](/workflows/add-merged-pr-to-changelog/add-merged-pr-to-changelog.yml) | Appends a summary of a merged pull request to an issue. | @phazonoverload |
69

7-
1. Clone this repository.
8-
2. Update the documentation in the `docs` folder (including the `README.md` folder).
9-
3. Customize the code and other content as needed.
10-
4. Update the `SUPPORT.md` file with the appropriate information.
11-
5. Review the default LICENSE (MIT), CODE_OF_CONDUCT, and CONTRIBUTING files to ensure they meet your needs. These use the samples provided as part of the OSPO release process.
12-
6. Update the `README.md` file in the repository root with the appropriate information. You can find an example at [github-samples/game-of-life-walkthrough](https://github.com/github-samples/game-of-life-walkthrough).
13-
7. Update the [devcontainer template](.devcontainer/devcontainer.json) so that it has all the needed tools, frameworks and extensions installed so those using your sample can get going quickly.
14-
8. When you are ready to publish the repository, please make sure that the Git history is clean. Then, raise an issue for a 'sample release' at [https://github.com/github/open-source-releases](https://github.com/github/open-source-releases).
10+
## License
11+
12+
This project is licensed under the terms of the MIT open source license. Please refer to [MIT](./LICENSE) for the full terms.
13+
14+
## Maintainers
15+
16+
See maintainers in the [CODEOWNERS](https://github.com/github-samples/models-in-actions/blob/main/.github/CODEOWNERS) file.
17+
18+
## Support
19+
20+
Our team will try their best to respond to issues and pull requests in a timely manner. However, please note that this is an open source project and support may be limited.

SUPPORT.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,12 @@
1-
2-
# TODO: The maintainer of this repo has not updated this file
3-
41
# Support
52

63
## How to file issues and get help
74

85
This project uses GitHub issues to track bugs and feature requests. Please search the existing issues before filing new issues to avoid duplicates. For new issues, file your bug or feature request as a new issue.
96

10-
For help or questions about using this project, please **TODO:** REPO MAINTAINER TO INSERT INSTRUCTIONS ON HOW TO ENGAGE REPO OWNERS OR COMMUNITY FOR HELP. COULD BE A SLACK OR DISCORD OR OTHER CHANNEL FOR HELP. WHERE WILL YOU HELP PEOPLE?
11-
12-
**TODO: REPO MAINTAINERS** Please include one of the following statements file:
7+
For help or questions about using this project, please open issues on this repository.
138

14-
- **THIS PROJECT NAME** is under active development and maintained by GitHub staff **AND THE COMMUNITY**. We will do our best to respond to support, feature requests, and community questions in a timely manner.
15-
- **THIS PROJECT NAME** is not actively developed but is maintained by GitHub staff **AND THE COMMUNITY**. We will do our best to respond to support and community questions in a timely manner.
16-
- **THIS PROJECT NAME** is no longer supported or maintained by GitHub staff. We will not respond to support or community questions.
17-
- **THIS PROJECT NAME** is archived and deprecated. As an unsupported project, feel free to fork.
9+
This collection of workflows is under active development and maintained by GitHub staff **AND THE COMMUNITY**. We will do our best to respond to support, feature requests, and community questions in a timely manner.
1810

1911
## GitHub Support Policy
2012

docs/0-pre-requisites.md

Lines changed: 0 additions & 16 deletions
This file was deleted.

docs/1-introduction.md

Lines changed: 0 additions & 16 deletions
This file was deleted.

docs/README.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

docs/images/README.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/template.md

Lines changed: 0 additions & 24 deletions
This file was deleted.

0 commit comments

Comments
 (0)