Skip to content
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.

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

[Android Wiki] Added "Tips and Tricks" for android wiki contribution #4921

Merged
merged 16 commits into from
Mar 31, 2023
Merged

[Android Wiki] Added "Tips and Tricks" for android wiki contribution #4921

merged 16 commits into from
Mar 31, 2023

Conversation

MohitGupta121
Copy link
Member

@MohitGupta121 MohitGupta121 commented Mar 25, 2023

Explanation

[Android Wiki] Added "Tips and Tricks" for android wiki contribution

  • Tips for Wiki Markdown Preview in Android Studio

Essential Checklist

  • The PR title and explanation each start with "Fix #bugnum: " (If this PR fixes part of an issue, prefix the title with "Fix part of #bugnum: ...".)
  • Any changes to scripts/assets files have their rationale included in the PR explanation.
  • The PR follows the style guide.
  • The PR does not contain any unnecessary code changes from Android Studio (reference).
  • The PR is made from a branch that's not called "develop" and is up-to-date with "develop".
  • The PR is assigned to the appropriate reviewers (reference).

Copy link
Member Author

@MohitGupta121 MohitGupta121 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gp201 @BenHenning PTAL, I make changes for preview as we discuss.

@MohitGupta121 MohitGupta121 changed the title [Android Wiki] Added "Tips and Try" for android wiki contribution [Android Wiki] Added "Tips and Tricks" for android wiki contribution Mar 25, 2023
wiki/Wiki.md Show resolved Hide resolved
@gp201 gp201 assigned MohitGupta121 and unassigned gp201 Mar 27, 2023
@MohitGupta121 MohitGupta121 removed their assignment Mar 27, 2023
Copy link
Member Author

@MohitGupta121 MohitGupta121 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gp201 PTAL, updated review changes.

Copy link
Member

@BenHenning BenHenning left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @MohitGupta121! I really like the idea of including tips & tricks, and especially the one that you're adding, but I do have some concerns with the steps that need to be followed. PTAL.

wiki/Wiki.md Show resolved Hide resolved
wiki/Wiki.md Outdated Show resolved Hide resolved
Copy link
Member

@gp201 gp201 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@gp201 gp201 removed their assignment Mar 30, 2023
@MohitGupta121 MohitGupta121 removed their assignment Mar 31, 2023
Copy link
Member Author

@MohitGupta121 MohitGupta121 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@BenHenning PTAL, I updated the wiki and added TODO issue but getting TODO Regex error, I try it on my local system to run the TODO bazel test but not able to test it in local and not able to find why it's failing even I use exact pattern for TODO.
Thanks.

This command I use to run the TODO test, I also get open_issues.json as per mention in this comments.
bazel run //scripts:todo_open_check -- $(pwd) scripts/assets/todo_open_exemptions.pb open_issues.json

Copy link
Member

@BenHenning BenHenning left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @MohitGupta121! Just had one follow-up--PTAL.

wiki/Wiki.md Outdated Show resolved Hide resolved
wiki/Wiki.md Show resolved Hide resolved
@MohitGupta121 MohitGupta121 removed their assignment Mar 31, 2023
Copy link
Member Author

@MohitGupta121 MohitGupta121 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@BenHenning Thanks, PTAL.
Updated the TODO

Copy link
Member

@BenHenning BenHenning left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @MohitGupta121! This LGTM!

@BenHenning BenHenning merged commit 60b8034 into oppia:develop Mar 31, 2023
@MohitGupta121 MohitGupta121 deleted the tips_and_try_wiki branch March 31, 2023 20:46
Uticodes pushed a commit to Uticodes/oppia-android that referenced this pull request Apr 4, 2023
…ppia#4921)

<!-- READ ME FIRST: Please fill in the explanation section below and
check off every point from the Essential Checklist! -->
## Explanation

[Android Wiki] Added "Tips and Tricks" for android wiki contribution 

- Tips for Wiki Markdown Preview in Android Studio 


<!--
- Explain what your PR does. If this PR fixes an existing bug, please
include
- "Fixes #bugnum:" in the explanation so that GitHub can auto-close the
issue
  - when this PR is merged.
  -->

## Essential Checklist
<!-- Please tick the relevant boxes by putting an "x" in them. -->
- [x] The PR title and explanation each start with "Fix #bugnum: " (If
this PR fixes part of an issue, prefix the title with "Fix part of
#bugnum: ...".)
- [x] Any changes to
[scripts/assets](https://github.com/oppia/oppia-android/tree/develop/scripts/assets)
files have their rationale included in the PR explanation.
- [x] The PR follows the [style
guide](https://github.com/oppia/oppia-android/wiki/Coding-style-guide).
- [x] The PR does not contain any unnecessary code changes from Android
Studio
([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#undo-unnecessary-changes)).
- [x] The PR is made from a branch that's **not** called "develop" and
is up-to-date with "develop".
- [x] The PR is **assigned** to the appropriate reviewers
([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#clarification-regarding-assignees-and-reviewers-section)).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants