Skip to content

Commit

Permalink
Merge pull request #15 from ynput/release_v0_1-0
Browse files Browse the repository at this point in the history
Release v0 1 0
  • Loading branch information
Lypsolon authored Aug 26, 2024
2 parents 68aa956 + 8f0cb10 commit b69e389
Showing 1 changed file with 26 additions and 3 deletions.
29 changes: 26 additions & 3 deletions Docs/src/md/Getting_Started.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,31 @@ target_link_libraries(Your-Project AyonCppApi)

## Developing for this tool set

### General

When developing for this tool we try to follow the idea of Red Green development
by first building a test that fails and then implementing the system that solves
the test case.\n We try to have the maximum test coverage so if you find an edge
case it might be worth implementing a test case just for that even if you know
that the edge case is already solved.
the test case.

We try to keep everything we work on in GH issues and create branches from that.
There are 3 Issue Options.

- Bug Report
- Feature Request
- Proposal

Feel free to use what every fits the scale of work you want to do but if you
work on a bigger feature that holds quite a bit of complexity a Proposal would
be important so that we can debate if the technical approach to the idea can be
implemented this way, it also allows us to go back to older proposals and see
what and why we decided for specific solutions.

### Testing

We try to have the maximum test coverage so if you find an edge case it might be
worth implementing a test case just for that even if you know that the edge case
is already solved.

Currently all tests live in the GTestMain.cpp file this is about to change in
the near future and we will build tests similar to how we do it in the
[AyonDevTools](https://github.com/ynput/ayon-cpp-dev-tools)

0 comments on commit b69e389

Please sign in to comment.