This repository has been archived by the owner on Feb 26, 2023. It is now read-only.
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.
- 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.
- 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.
19/11/2020 The 4.8.0 release is out !
- Get started!
- Cookbook, full of recipes
- Customize annotation processing
- List of all available annotations
- Release Notes
- Examples
- Read the FAQ
- Join the Mailing list
- Create an issue
- Tag on Stack Overflow
- Ask on Gitter