aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorDave Gauer <dave@ratfactor.com>2022-07-31 16:20:12 -0400
committerDave Gauer <dave@ratfactor.com>2022-07-31 16:20:12 -0400
commit56c085c380c8a0892d6cc03744c65a4b25118255 (patch)
tree7120d3a65f13bdba0470761e9c4fc783b3386d4c /CONTRIBUTING.md
parentb8617bb7527d39874b507a4c25bdaa8b6c4f4c3f (diff)
downloadziglings-56c085c380c8a0892d6cc03744c65a4b25118255.tar.gz
ziglings-56c085c380c8a0892d6cc03744c65a4b25118255.tar.bz2
ziglings-56c085c380c8a0892d6cc03744c65a4b25118255.tar.xz
ziglings-56c085c380c8a0892d6cc03744c65a4b25118255.zip
Improve CONTRIBUTING, rewrap text
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md83
1 files changed, 44 insertions, 39 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index eb80688..7d15cc6 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,79 +1,84 @@
# Contributing
-By reading this document, you have already entered the Elite Hall of Ziglings
-Maintenance!
+By reading this document, you have already entered the Elite Hall
+of Ziglings Maintenance!
## The Ziglings Audience
-Ziglings is intended for programmers of all experience levels. No specific
-language knowledge is expected. If you can install the current Zig snapshot,
-setup a copy of Ziglings, and understand if/then/else, loops, and functions,
-then you're ready.
+Ziglings is intended for programmers of all experience levels. No
+specific language knowledge is expected. Anyone who can install
+the current Zig snapshot, setup a copy of Ziglings, and knows
+common language building blocks (if/then/else, loops, and
+functions) is ready or Ziglings.
-Experience with strong typing, manual memory management, and certain language
-constructs and idioms will greatly increase the speed at which you'll be able
-to tackle each exercise. But speed isn't important, only learning is important.
+Ziglings is intended to be completely self-contained. If you
+can't solve an exercise from the information you've gleaned so
+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
-exercise from the information you've gleaned so far from Ziglings, then the
-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!
+If an example doesn't match a description or if something is
+unclear, please file an issue!
## 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
-If you have ideas for new lessons or a way Ziglings could be improved, don't
-hesitate to file an issue.
+If you have ideas for new lessons or a way Ziglings could be
+improved, don't hesitate to file an issue.
-I prefer to actually write all of the content myself at this time (part of the
-reason I'm building Ziglings is to learn Zig myself!), but I'm always open to
-ideas.
+I prefer to write the bulk of the content myself at this time
+(part of the reason I'm building Ziglings is to learn Zig
+myself!), but I'm always open to ideas.
## 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
-development of Zig.
+Since Ziglings is a Zig language learning resource, it tracks the
+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
-latest development build of Zig and the latest commit to Ziglings), that's a
-bug! Please file an issue.
+If you run into an error in Ziglings caused by breaking changes
+in the latest development build of Zig, that's a new bug in
+Ziglings. Please file an issue...or make a pull request!
## 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
-Ziglings uses the "standard" Github workflow as guided by the Web interface.
-Specifically:
+Ziglings uses the "standard" Github workflow as guided by the Web
+interface. Specifically:
* 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
-* When your changes are ready for review, push your branch: `git push origin
- my-branch`
+* When your changes are ready for review, push your branch:
+ `git push origin my-branch`
* Create a pull request from your branch to `ziglings/main`
-* Your faithful Ziglings maintainer "ratfactor" (that's me!) will take a look
- at your request ASAP
-* Once the changes are reviewed, your request will be merged and eternal
- Ziglings contributor glory is yours!
+* Your faithful Ziglings maintainer "ratfactor" (that's me!) will
+ take a look at your request ASAP (we don't talk about May-July
+ 2022, LOL)
+* Once the changes are reviewed, your request will be merged and
+ eternal Ziglings contributor glory is yours!
## 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.