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

Create User-Manual-for-fAIr.md #144

Merged
merged 2 commits into from
Aug 22, 2023
Merged

Conversation

neelimagoogly
Copy link
Contributor

I have created the User Manual for fAIr which includes step by step tutorial on how to get started with fAIr wrt issue #132 .
@petya-kangalova , @kshitijrajsharma and @omranlm please review it.

@neelimagoogly neelimagoogly added documentation Improvements or additions to documentation priority:high Outreachy Project tasks for Outreachy internship - May to August 2023 labels Jul 29, 2023
@neelimagoogly neelimagoogly self-assigned this Jul 29, 2023
@kshitijrajsharma
Copy link
Member

kshitijrajsharma commented Aug 7, 2023

HI @neelimagoogly , Thanks for the PR !
Its a good practice to use Github Keywords in issues/ PR https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests . For example for This PR
It could be

Here , this resolve keyword with issue which is resolved / contributed by PR will be closed automatically when PR is reviewed and merged !
And also one suggestion on branching and commit messages ( I also personally need to work on commit msgs though haha )
We use [commitizen](https://commitizen-tools.github.io/commitizen/) , It would be easy and good on long run if you have proper naming for your branch and commit . In long term People may forget and try to checkout the work done or even for the developer itself it would be hard to track and manage branches if it is patch 1 patch 2 if you name it differently then will be easy to follow , for eg : for this PR it could be docs/tutorial

@neelimagoogly
Copy link
Contributor Author

Thanks a lot @kshitijrajsharma . I would definitely follow this practice onwards .

@kshitijrajsharma kshitijrajsharma added the Needs Review Means , This needs review from someone label Aug 10, 2023
@@ -0,0 +1,235 @@
# User Manual for FMTM
Copy link
Member

Choose a reason for hiding this comment

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

User Manual for fAIr

@kshitijrajsharma kshitijrajsharma merged commit 91845cd into master Aug 22, 2023
1 of 2 checks passed
@kshitijrajsharma kshitijrajsharma deleted the neelimagoogly-patch-1 branch August 22, 2023 10:39
@petya-kangalova
Copy link
Contributor

petya-kangalova commented Nov 22, 2023

@kshitijrajsharma @omranlm I know this PR has been merged, can we now link the content to this page https://fair-dev.hotosm.org/documentation ? I can then also build an FAQ and link to documentation and we can even add some of the videos/tutorials there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Needs Review Means , This needs review from someone Outreachy Project tasks for Outreachy internship - May to August 2023 priority:high
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants