Skip to content

Commit

Permalink
3: Move issues into a folder of their own
Browse files Browse the repository at this point in the history
  • Loading branch information
jamesaorson committed Jun 19, 2024
1 parent 59512b2 commit de4d52b
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 25 deletions.
6 changes: 5 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
5 changes: 5 additions & 0 deletions issues/closed.md
Original file line number Diff line number Diff line change
@@ -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)
32 changes: 8 additions & 24 deletions Issues.md → issues/in-progress.md
Original file line number Diff line number Diff line change
@@ -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:

Expand All @@ -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)
3 changes: 3 additions & 0 deletions issues/open.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Open Issues

- [Open issues search](https://github.com/ExoKomodo/openwomb/issues?q=is%3Aissue+is%3Aopen+no%3Aassignee)

0 comments on commit de4d52b

Please sign in to comment.