Parcourir la Source

(hacking.md): Add a contributing section

Javier Olaechea il y a 10 ans
Parent
commit
71b535648f
1 fichiers modifiés avec 51 ajouts et 0 suppressions
  1. 51 0
      docs/hacking.md

+ 51 - 0
docs/hacking.md

@@ -341,6 +341,57 @@ Unfortunately, this does not solve:
341 341
    Content Types it includes or the CONTENT which indexes it appears
342 342
    on is not yet clear.
343 343
 
344
+### Contributing
345
+
346
+The preferred workflow is more or less:
347
+
348
+    - fork and clone
349
+    - make a branch
350
+    - commit your changes
351
+    - push your branch to your github fork
352
+    - open a Pull Request
353
+
354
+#### Fork and clone
355
+
356
+You may clone the main github repository or your fork, whichever you cloned
357
+will be known as origin in your git repository. You have to add the other git
358
+repository to your remotes, so if you cloned from your fork execute:
359
+
360
+
361
+```bash
362
+git remote add upstream git@github.com:redline6561/coleslaw.git
363
+```
364
+
365
+If you cloned from the main github repository execute:
366
+
367
+```bash
368
+git remote add fork git@github.com:<YourUsername>/coleslaw.git
369
+```
370
+
371
+For the rest of the steps we will assume you cloned from your fork and that the main github repository has the remote name of upstream.
372
+
373
+#### Make a branch
374
+
375
+```bash
376
+git checkout -b <branch_name>
377
+```
378
+
379
+It is important to work always on branch so one can track changes in upstream by simply executing ```git pull upstream master:master``` from the master branch. If one can't come up with a suitable branch name just name it patch-n.
380
+2
381
+#### Commit your changes
382
+
383
+Make the changes you want to coleslaw, add the files with that changes (```git add <path/to/file>```) and commit them (```git commit```). Your commit message should strive to sum up what has changes and why.
384
+
385
+#### Push your branch to your github fork
386
+
387
+```bash
388
+git push origin branch
389
+```
390
+
391
+#### Open a Pull Request
392
+
393
+After pushing the branch to your fork, on github you should see a button to open a pull request. In the PR message give the rationale for your changes.
394
+
344 395
 [closure_template]: https://github.com/archimag/cl-closure-template
345 396
 [api_docs]: https://github.com/redline6561/coleslaw/blob/master/docs/plugin-api.md
346 397
 [clmd]: https://github.com/gwkkwg/cl-markdown