From 7017cd84459f9b13539080d5ae36172872c3f7ad Mon Sep 17 00:00:00 2001 From: Mike Kamermans Date: Fri, 17 Feb 2017 11:19:01 -0800 Subject: [PATCH] Updated Home (markdown) --- Home.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/Home.md b/Home.md index 0dc49fa..8996302 100644 --- a/Home.md +++ b/Home.md @@ -1 +1,16 @@ -How to [[localize]] +# Working on the Primer + +The main way to contribute to the primer is to file issues, write content/code, and file pull requests, in that order: + +- file an issue for something that you think should be added, modified, or removed. Note that you might want more than one thing: please file one issue for one thing. This ensures others (including me, Pomax) can easily understand the work involved, and prevents issue-associated code changes from growing to immense and unreviewable size. + +Discussion of the issue will happen in the issue itself. + +- if you want to write code, please fork the project, then write your code changes in **any branch that is not master**. Never work in the master branch: that branch should be kept up to date with the main repo's master branch. +- When you're happy with your code, form a pull request from your not-master-branch to the Bezierinfo-2 master branch, and make sure to add "fixes #..." with the associated issue number for the `...` part. This lets github crosslink the two so that if the PR gets merged in, the associated issue is automated closed. + +Once you have filed a PR, discussion of the code will happen in the form of pull request review notes. Any non-code issues that surface will be discussed in the associated issue. + +## Localization + +Click the following link for information on how to [[localize]] this primer.