HowToEditWiki

Tamas Vegh edited this page Sep 7, 2017 · 4 revisions

Here you can read information about how to contribute to our documentation in the wiki. Unfortunately the wiki is not open to anyone, but you can still edit it in a similar way you can write code in this project. It may not be obvious, but a wiki in GitHub is just a simple git repository. You can clone the main wiki, create changes in it, then those can be integrated to the main project.

General steps for editing the wiki

  • Fork the repository
  • Open the wiki in it
  • It should say the wiki is empty, create the home page with the green button
  • Write anything to the page and save it
  • Now you are able to clone your wiki
git clone git@github.com:<YOUR_GITHUB_USERNAME>/androidannotations.wiki.git
cd androidannotations.wiki
  • Add the upstream remote
git remote add upstream git@github.com:androidannotations/androidannotations.wiki.git
  • Fetch and reset the HEAD to the latest committed state of upstream
git fetch upstream
git reset upstream/master —-hard
  • Edit or create pages you want
  • Open an issue to notify us about your contribution, then we can merge your changes to the main wiki.

Steps for merging upstream changes

  • Clone your wiki
git clone git@github.com:<YOUR_GITHUB_USERNAME>/androidannotations.wiki.git
cd androidannotations.wiki
  • Add the upstream remote
git remote add upstream git@github.com:androidannotations/androidannotations.wiki.git
  • Fetch and merge new content from upstream
git fetch upstream
git merge upstream/master
  • Push the changes to your remote wiki repository
git push
  • At this point your wiki is up-to-date with the main wiki, and you can safely edit the pages without creating a conflict.

14/10/2018 The 4.5.1 release is out !

Using AndroidAnnotations

Questions?

Enjoying AndroidAnnotations

Improving AndroidAnnotations

Extending AndroidAnnotations

Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.