flo/todo.txt-cli
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

textile to markdown

Ali Karbassi
2018-07-05 23:11:51 -05:00
parent 03c667c841
commit 8f6eb05410
2 changed files with 43 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
Developer-Documentation.md Normal file

@@ -0,0 +1,43 @@
To contribute to Todo.txt CLI, *fork [the repository](http://github.com/todotxt/todo.txt-cli)* and make your changes, including tests. *Then issue a pull request* via GitHub to submit your changes for review and possible inclusion in the master. Big or disruptive changes are best discussed on the [mailing list](http://groups.yahoo.com/group/todotxt/) first.
* [[Creating Add-ons: Examples]]
* [[Using the Makefile]]
* [Known Bugs](http://github.com/todotxt/todo.txt-cli/issues)
## Contributing patches and enhancements via Git / GitHub
### Initial Fork
You need to register on GitHub first - it's free and quick to do. After registering, you need to add your SSH public keys to be able to push your changes to your repository. On the [Todo.txt GitHub pages](http://github.com/todotxt/todo.txt-cli/), click the _Fork this project_ button. This will create your personal fork `git@github.com:username/projectname.git`.
On your dev system, install Git and clone your repository:
```bash
$ git clone git@github.com:username/todo.txt-cli.git
```
We'll add Gina's authoritative repository as _upstream_, so that you can easily sync with it:
```bash
$ git remote add upstream git://github.com/todotxt/todo.txt-cli.git
$ git fetch upstream
```
### Publishing Changes
```bash
$ git add ...
$ git commit ...
$ git push origin master
```
The changes now appear in your repository in your GitHub clone; you'll see the commits listed in the GitHub web interface. You can now initiate a pull request by clicking the _Pull Request_ button. Send the request to the maintainers. You will receive a message (in GitHub and via Email) when she has merged in your changes; or just occasionally check [the changelog](http://github.com/todotxt/todo.txt-cli/).
### Pulling in Upstream
Some time has passed, the upstream repo has changed and you want to update your fork before you submit a new patch. Do this to bring your dev system up-to-date:
```bash
$ git fetch upstream
$ git merge upstream/master
```

43
Developer-Documentation.textile

@@ -1,43 +0,0 @@
To contribute to Todo.txt CLI, *fork "the repository":http://github.com/ginatrapani/todo.txt-cli/tree/master* and make your changes, including tests. *Then issue a pull request* via GitHub to submit your changes for review and possible inclusion in the master. Big or disruptive changes are best discussed on the "mailing list":http://groups.yahoo.com/group/todotxt/ first.
* [[Creating Add-ons: Examples]]
* [[Using the Makefile]]
* "Known Bugs":http://github.com/ginatrapani/todo.txt-cli/issues
h2. Contributing patches and enhancements via Git / GitHub
h3. Initial Fork
You need to register on GitHub first - it's free and quick to do. After registering, you need to add your SSH public keys to be able to push your changes to your repository. On the "Todo.txt GitHub pages":http://github.com/ginatrapani/todo.txt-cli/tree/master, click the __Fork this project__ button. This will create your personal fork git@github.com:username/projectname.git.
On your dev system, install Git and clone your repository:
<pre>
git clone git@github.com:username/todo.txt-cli.git
</pre>
We'll add Gina's authoritative repository as __upstream__, so that you can easily sync with it:
<pre>
git remote add upstream git://github.com/ginatrapani/todo.txt-cli.git
git fetch upstream
</pre>
h3. Publishing Changes
<pre>
git add ...
git commit ...
git push origin master
</pre>
The changes now appear in your repository in your GitHub clone; you'll see the commits listed in the GitHub web interface. You can now initiate a pull request by clicking the __Pull Request__ button. Send the request to Gina, the maintainer. You will receive a message (in GitHub and via Email) when she has merged in your changes; or just occasionally check "the history of Gina's repository":http://github.com/ginatrapani/todo.txt-cli/commits/master/.
h3. Pulling in Upstream
Some time has passed, the upstream repo has changed and you want to update your fork before you submit a new patch. Do this to bring your dev system up-to-date:
<pre>
git fetch upstream
git merge upstream/master
</pre>