Skip to content

Contributing-Guidelines: point to documentation repo #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 23, 2020
Merged

Contributing-Guidelines: point to documentation repo #11

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4d31c8a
Contributing-Guidelines: point to documentation repo
sivaraam Mar 23, 2020
1a1a58d
Contributing-Guidelines: fix more wiki references
sivaraam Mar 23, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions android/Contributing-Guidelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Thanks for considering to contribute to this project! A few guidelines for
people who want to contribute their code to this software are documented
here. If you're not sure where to start head on to [this wiki page](https://github.com/commons-app/apps-android-commons/wiki/Volunteers-welcome!).
here. If you're not sure where to start read the [Volunteers welcome!](./Volunteers-welcome!.md) document.

## Summary

Expand All @@ -24,11 +24,11 @@ You should also:

## Code Style

https://github.com/commons-app/apps-android-commons/wiki/Code-style
See [Code Style](Code-style.md) document.

## Developer Workflow

https://github.com/commons-app/apps-android-commons/wiki/Developer-workflow
See [Developer workflow](Developer-workflow.md) document.

## General Guidelines

Expand Down Expand Up @@ -112,10 +112,10 @@ on open source projects), you can use their Travis CI integration to
test your changes.


### Update the Wiki pages (if possible)
### Update the documentation pages (if possible)

Do not forget to update the [Wiki pages](https://github.com/commons-app/apps-android-commons/wiki)
Do not forget to update the [documentation pages](https://github.com/commons-app/documentation/blob/master/android/)
on GitHub to describe the updated behavior and make sure that the resulting
Wiki pages don't become stale as a consequence of your change.
documentation pages don't become stale as a consequence of your change.

Note: These guidelines are based on the Git project's [guideline for submitting patches](https://github.com/git/git/blob/master/Documentation/SubmittingPatches). It's licensed under GPLv2.
Note: These guidelines are based on the Git project's [guideline for submitting patches](https://github.com/git/git/blob/master/Documentation/SubmittingPatches). It's licensed under GPLv2.