From de4d52b25682d10959b3c71c8ba1eb1106f0e926 Mon Sep 17 00:00:00 2001 From: James Orson Date: Wed, 19 Jun 2024 08:35:20 -0700 Subject: [PATCH] 3: Move issues into a folder of their own --- CONTRIBUTING.md | 6 +++++- issues/closed.md | 5 +++++ Issues.md => issues/in-progress.md | 32 ++++++++---------------------- issues/open.md | 3 +++ 4 files changed, 21 insertions(+), 25 deletions(-) create mode 100644 issues/closed.md rename Issues.md => issues/in-progress.md (60%) create mode 100644 issues/open.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2e69490..24e56d4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,4 +6,8 @@ ## What can I work on? -Check out the [issues file](./Issues.md) to understand what work needs to be done, and to find the official issue tracker for the project +Check out the [open issues file](./issues/open.md) to understand what work needs to be done. + +## Why is there an issue tracker in the codebase and in our SCM solution? + +Github does provide nice linking to issues for PRs and for the community to add issues to the project without having code access. The issues markdown files in the repo should be represented in Github as well, but are usually of higher priority and more immediately available to be worked on. diff --git a/issues/closed.md b/issues/closed.md new file mode 100644 index 0000000..f93ab3b --- /dev/null +++ b/issues/closed.md @@ -0,0 +1,5 @@ +# Open Issues + +Move [in-progress](./in-progress.md) issues to this file when completed + +- [Closed issues search](https://github.com/ExoKomodo/openwomb/issues?q=is%3Aissue+is%3Aclosed) diff --git a/Issues.md b/issues/in-progress.md similarity index 60% rename from Issues.md rename to issues/in-progress.md index 5b2ddab..0be7fea 100644 --- a/Issues.md +++ b/issues/in-progress.md @@ -1,26 +1,14 @@ -# Issues +# In-Progress Issues -## Important Links +Once completed, move the issue into [closed](./closed.md), and also close it within the [Official Issue Tracker](https://github.com/exokomodo/openwomb/issues) -- [Official Issue Tracker](https://github.com/exokomodo/openwomb/issues) +## Render textures/sprites -### Why? +### [Issue Link](https://github.com/ExoKomodo/openwomb/issues/3) -Sick of not having issues co-local to the codebase, and this allows for more freeform planning and discussion, before dumping it into a PR or official issue. Also allows for platform-agnostic issue handling if we ever move off of Github. +### Branch - [3_sprites](https://github.com/exokomodo/openwomb/tree/3_sprites) -## Open - -To check all open issues on Github, [go here](https://github.com/ExoKomodo/openwomb/issues?q=is%3Aopen+is%3Aissue) - -## In-Progress - -### Render textures/sprites - -#### [Issue Link](https://github.com/ExoKomodo/openwomb/issues/3) - -#### Branch - [3_sprites](https://github.com/exokomodo/openwomb/tree/3_sprites) - -#### Overview +### Overview There are 2 different ways to render images with SDL: @@ -29,17 +17,13 @@ There are 2 different ways to render images with SDL: This issue is to only implement the OpenGL way, as it provides a general-purpose use case, since rendering to a quad is all that is "needed" for dealing with images and textures in graphics. -#### Instructions +### Instructions 1. Read the [OpenGL tutorial for rendering textures to a quad](https://learnopengl.com/Getting-started/Textures). Now prepare for implementation. 1. Will require some changes to the [Primitives.ShadedObject.From function](./src/Womb/Graphics/Primitives.fs) 1. Will require some changes to the [Primitives.ShadedObject.UseMvpShader function](./src/Womb/Graphics/Primitives.fs) 1. Will require some changes to the [example shaders in the Playground example](./examples/Playground/Resources/Shaders/) -#### Acceptance Criteria +### Acceptance Criteria Be able to render an image to a shaded quad. To demonstrate this, modify the [Playground example](./examples/Playground) to render the [hello_world.bmp](./examples/Playground/Resources/Textures/hello_world.bmp). For proper completeness, demonstrate how we can color the texture in the shader as well. - -## Closed - -To check all closed issues on Github, [go here](https://github.com/ExoKomodo/openwomb/issues?q=is%3Aissue+is%3Aclosed) diff --git a/issues/open.md b/issues/open.md new file mode 100644 index 0000000..943482f --- /dev/null +++ b/issues/open.md @@ -0,0 +1,3 @@ +# Open Issues + +- [Open issues search](https://github.com/ExoKomodo/openwomb/issues?q=is%3Aissue+is%3Aopen+no%3Aassignee)