-
-
Notifications
You must be signed in to change notification settings - Fork 146
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
10 changed files
with
368 additions
and
122 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# Maintainers Guide | ||
|
||
This document is intended primarily for project maintainers of the zig-gamedev monorepo but may also contain useful information for other contributors and users. | ||
|
||
|
||
## Branch Strategy | ||
|
||
[Zig](https://ziglang.org) development happens fast; with stable releases being infrequent (once or twice a year). We want to take advantage of recent improvements and features of the compiler but maintain some stabilty and compatibilty with the wider Zig ecosystem. | ||
|
||
Our branch strategy facilitates parallel development for contributors and users who want stabilty from a [nominated Zig version](#nominated-zig-version) and those seeking the bleeding edge of Zig's nightly build. This strategy should be reviewed as the Zig compiler and the zig-gamedev project mature. | ||
|
||
Development primarily happens on the [main branch](https://github.com/zig-gamedev/zig-gamedev/tree/main). It tracks a periodically [nominated Zig version](#nominated-zig-version). This is this branch that we recommend for most users. We have [GitHub Actions](https://github.com/zig-gamedev/zig-gamedev/actions/workflows/main.yml) run on pushes and PRs to this branch and it receives the majority of testing effort. It should provide a fairly reliable foundation for users to base their projects on. | ||
|
||
For users who wish to blaze ahead, the [unstable branch](https://github.com/zig-gamedev/zig-gamedev/tree/unstable) is intended to loosely track Zig nightly builds, although it will likely lag behind in practise. Users of this branch should expect things to break from time to time and be prepared to fix things. Features and fixes happening on the main branch are integrated into unstable requently. | ||
|
||
Pull requests to either branch are welcome. | ||
|
||
### PRs to main | ||
Pull requests to the [main branch](https://github.com/zig-gamedev/zig-gamedev/tree/main) are preferred as this is where the majority of development effort is focussed. [GitHub Actions](https://github.com/zig-gamedev/zig-gamedev/actions/workflows/main.yml) are setup to build all demo applications, libraries and run unit tests on each supported development environment. The maintainer who merges changes should run and test changes locally at their discretion. | ||
|
||
### PRs to unstable | ||
Pull requests to the [unstable branch](https://github.com/zig-gamedev/zig-gamedev/tree/main) should at least be compatible with the minimum supported Zig version as asserted by the top-level [build.zig](https://github.com/zig-gamedev/zig-gamedev/blob/unstable/build.zig). Note that there is no | ||
|
||
### Merging main -> unstable | ||
TODO | ||
|
||
### Merging unstable -> main | ||
TODO | ||
|
||
### Nominated Zig version | ||
TODO | ||
|
||
|
||
## Releases | ||
TODO | ||
|
||
|
||
## Package Releases | ||
TODO |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
.{ | ||
.name = "zaudio", | ||
.version = "0.9.3", | ||
.version = "0.9.4", | ||
.paths = .{ | ||
"build.zig", | ||
"build.zig.zon", | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
This software is available as a choice of the following licenses. Choose | ||
whichever you prefer. | ||
|
||
=============================================================================== | ||
ALTERNATIVE 1 - Public Domain (www.unlicense.org) | ||
=============================================================================== | ||
This is free and unencumbered software released into the public domain. | ||
|
||
Anyone is free to copy, modify, publish, use, compile, sell, or distribute this | ||
software, either in source code form or as a compiled binary, for any purpose, | ||
commercial or non-commercial, and by any means. | ||
|
||
In jurisdictions that recognize copyright laws, the author or authors of this | ||
software dedicate any and all copyright interest in the software to the public | ||
domain. We make this dedication for the benefit of the public at large and to | ||
the detriment of our heirs and successors. We intend this dedication to be an | ||
overt act of relinquishment in perpetuity of all present and future rights to | ||
this software under copyright law. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN | ||
ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION | ||
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | ||
|
||
For more information, please refer to <http://unlicense.org/> | ||
|
||
=============================================================================== | ||
ALTERNATIVE 2 - MIT No Attribution | ||
=============================================================================== | ||
Copyright 2023 David Reid | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy of | ||
this software and associated documentation files (the "Software"), to deal in | ||
the Software without restriction, including without limitation the rights to | ||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies | ||
of the Software, and to permit persons to whom the Software is furnished to do | ||
so. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
Oops, something went wrong.