mirror of
https://codeberg.org/andyscott/ziglings.git
synced 2024-12-22 22:13:11 -05:00
Improve CONTRIBUTING, rewrap text
This commit is contained in:
parent
dee6a96ddf
commit
84bd02138e
1 changed files with 44 additions and 39 deletions
|
@ -1,79 +1,84 @@
|
||||||
# Contributing
|
# Contributing
|
||||||
|
|
||||||
By reading this document, you have already entered the Elite Hall of Ziglings
|
By reading this document, you have already entered the Elite Hall
|
||||||
Maintenance!
|
of Ziglings Maintenance!
|
||||||
|
|
||||||
|
|
||||||
## The Ziglings Audience
|
## The Ziglings Audience
|
||||||
|
|
||||||
Ziglings is intended for programmers of all experience levels. No specific
|
Ziglings is intended for programmers of all experience levels. No
|
||||||
language knowledge is expected. If you can install the current Zig snapshot,
|
specific language knowledge is expected. Anyone who can install
|
||||||
setup a copy of Ziglings, and understand if/then/else, loops, and functions,
|
the current Zig snapshot, setup a copy of Ziglings, and knows
|
||||||
then you're ready.
|
common language building blocks (if/then/else, loops, and
|
||||||
|
functions) is ready or Ziglings.
|
||||||
|
|
||||||
Experience with strong typing, manual memory management, and certain language
|
Ziglings is intended to be completely self-contained. If you
|
||||||
constructs and idioms will greatly increase the speed at which you'll be able
|
can't solve an exercise from the information you've gleaned so
|
||||||
to tackle each exercise. But speed isn't important, only learning is important.
|
far from Ziglings, then the exercise probably needs some
|
||||||
|
additional work. Please file an issue!
|
||||||
|
|
||||||
Ziglings is intended to be completely self-contained. If you can't solve an
|
If an example doesn't match a description or if something is
|
||||||
exercise from the information you've gleaned so far from Ziglings, then the
|
unclear, please file an issue!
|
||||||
exercise probably needs some additional work. Please file an issue!
|
|
||||||
|
|
||||||
If an example doesn't match a description or if something is unclear, please
|
|
||||||
file an issue!
|
|
||||||
|
|
||||||
|
|
||||||
## Spelling/Grammar
|
## Spelling/Grammar
|
||||||
|
|
||||||
If you see any typos, please file an issue or make a pull request.
|
If you see any typos, please file an issue...or make a pull
|
||||||
|
request!
|
||||||
|
|
||||||
No mistake is too small. The Ziglings must be perfect.
|
No mistake is too small. The Ziglings must be perfect. :-)
|
||||||
|
|
||||||
|
|
||||||
## Ideas
|
## Ideas
|
||||||
|
|
||||||
If you have ideas for new lessons or a way Ziglings could be improved, don't
|
If you have ideas for new lessons or a way Ziglings could be
|
||||||
hesitate to file an issue.
|
improved, don't hesitate to file an issue.
|
||||||
|
|
||||||
I prefer to actually write all of the content myself at this time (part of the
|
I prefer to write the bulk of the content myself at this time
|
||||||
reason I'm building Ziglings is to learn Zig myself!), but I'm always open to
|
(part of the reason I'm building Ziglings is to learn Zig
|
||||||
ideas.
|
myself!), but I'm always open to ideas.
|
||||||
|
|
||||||
|
|
||||||
## Platforms and Zig Versions
|
## Platforms and Zig Versions
|
||||||
|
|
||||||
Because it uses the Zig build system, Ziglings should work wherever Zig does.
|
Because it uses the Zig build system, Ziglings should work
|
||||||
|
wherever Zig does.
|
||||||
|
|
||||||
Since Ziglings is a Zig language learning resource, it tracks the current
|
Since Ziglings is a Zig language learning resource, it tracks the
|
||||||
development of Zig.
|
current development snapshots of Zig from the official website
|
||||||
|
downloads page.
|
||||||
|
|
||||||
If you run into an error in Ziglings due to language changes (and you have the
|
If you run into an error in Ziglings caused by breaking changes
|
||||||
latest development build of Zig and the latest commit to Ziglings), that's a
|
in the latest development build of Zig, that's a new bug in
|
||||||
bug! Please file an issue.
|
Ziglings. Please file an issue...or make a pull request!
|
||||||
|
|
||||||
|
|
||||||
## Formatting
|
## Formatting
|
||||||
|
|
||||||
All exercises are (or should be) formatted with `zig fmt`.
|
All exercises should conformt to `zig fmt`. I often forget to do
|
||||||
|
this.
|
||||||
|
|
||||||
|
|
||||||
## Pull Request Workflow
|
## Pull Request Workflow
|
||||||
|
|
||||||
Ziglings uses the "standard" Github workflow as guided by the Web interface.
|
Ziglings uses the "standard" Github workflow as guided by the Web
|
||||||
Specifically:
|
interface. Specifically:
|
||||||
|
|
||||||
* Fork this repository
|
* Fork this repository
|
||||||
* Create a branch from `main` for your work: `git checkout -b my-branch`
|
* Create a branch from `main` for your work:
|
||||||
|
`git checkout -b my-branch`
|
||||||
* Make changes, commit them
|
* Make changes, commit them
|
||||||
* When your changes are ready for review, push your branch: `git push origin
|
* When your changes are ready for review, push your branch:
|
||||||
my-branch`
|
`git push origin my-branch`
|
||||||
* Create a pull request from your branch to `ziglings/main`
|
* Create a pull request from your branch to `ziglings/main`
|
||||||
* Your faithful Ziglings maintainer "ratfactor" (that's me!) will take a look
|
* Your faithful Ziglings maintainer "ratfactor" (that's me!) will
|
||||||
at your request ASAP
|
take a look at your request ASAP (we don't talk about May-July
|
||||||
* Once the changes are reviewed, your request will be merged and eternal
|
2022, LOL)
|
||||||
Ziglings contributor glory is yours!
|
* Once the changes are reviewed, your request will be merged and
|
||||||
|
eternal Ziglings contributor glory is yours!
|
||||||
|
|
||||||
|
|
||||||
## The Secrets
|
## The Secrets
|
||||||
|
|
||||||
If you want to peek at the secrets, take a look at the `patches/` directory.
|
If you want to peek at the secrets, take a look at the `patches/`
|
||||||
|
directory.
|
||||||
|
|
Loading…
Reference in a new issue