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

Add a GIT manual #15942

Open
wants to merge 1 commit into
base: QA_5_0
from
Open

Add a GIT manual #15942

wants to merge 1 commit into from

Conversation

@williamdes
Copy link
Member

williamdes commented Feb 9, 2020

Please comment and try to help make it simple.
I can get to much technical sometimes.

I am writing it on mobile so I will add more content from my pc soon and change base

asked by @gurrrung #15819 (comment)

I could convert it to .rst format and chose a better folder, please suggest

@codecov

This comment has been minimized.

Copy link

codecov bot commented Feb 9, 2020

Codecov Report

Merging #15942 into QA_5_0 will decrease coverage by 0.85%.
The diff coverage is 36.89%.

@@             Coverage Diff              @@
##             QA_5_0   #15942      +/-   ##
============================================
- Coverage     53.07%   52.21%   -0.86%     
- Complexity    14183    14879     +696     
============================================
  Files           482      468      -14     
  Lines         62221    61299     -922     
============================================
- Hits          33021    32005    -1016     
- Misses        29200    29294      +94
@williamdes

This comment has been minimized.

Copy link
Member Author

williamdes commented Feb 9, 2020

@yashrajbothra @kartik1000 if you could give me some comments on this alpha version of the file?

https://github.com/phpmyadmin/phpmyadmin/pull/15942/files?short_path=b74d2c6#diff-b74d2c6a6e35fef3746c7fe1ef55f386

You can use the rich mode to preview the file

.github/GIT_GUIDE.md Outdated Show resolved Hide resolved
.github/GIT_GUIDE.md Outdated Show resolved Hide resolved
@kartik1000

This comment has been minimized.

Copy link
Contributor

kartik1000 commented Feb 10, 2020

@williamdes For signoff line you can add git commit --amend --signoff command.

@kartik1000

This comment has been minimized.

Copy link
Contributor

kartik1000 commented Feb 10, 2020

@williamdes Also we can add how to cherry pick the commits as it is often required when rebasing.

@williamdes williamdes force-pushed the williamdes:git-guide branch from 8bf7a6b to 9835bcc Feb 10, 2020
@williamdes williamdes changed the base branch from master to QA_5_0 Feb 10, 2020
@williamdes

This comment has been minimized.

Copy link
Member Author

williamdes commented Feb 10, 2020

@williamdes For signoff line you can add git commit --amend --signoff command.

Done

@williamdes Also we can add how to cherry pick the commits as it is often required when rebasing.

Sure, I will add as much details as possible

@yashrajbothra

This comment has been minimized.

Copy link
Contributor

yashrajbothra commented Feb 10, 2020

@williamdes

This comment has been minimized.

Copy link
Member Author

williamdes commented Feb 10, 2020

https://github.com/phpmyadmin/phpmyadmin/wiki/Git @williamdes aren't these similar?

Yes, maybe I should merge or create a new wiki page

@kartik1000

This comment has been minimized.

Copy link
Contributor

kartik1000 commented Feb 10, 2020

@williamdes What you are creating now is quite in brief and I think this is what is required rather than too long documentations. I think most of the people know the basics but what is specific to pMA and what they require is what they need to learn.

@yashrajbothra

This comment has been minimized.

Copy link
Contributor

yashrajbothra commented Feb 10, 2020

If the Aim is to keep things short ,simple and point to point then its great.
But if our aim is to give breif explaination then making that old guide better is good idea IMO as its already in breif.

@victorphoenix3

This comment has been minimized.

Copy link
Contributor

victorphoenix3 commented Feb 11, 2020

@williamdes we should have a similar guide on how to set the Phpmyadmin system for development. It could include initial setup steps like cloning the repo in the var/www folder, setting allownopassword to true, running yarn install for recompiling scss, running phpstan, phpcbf , .tests/ci-phplint tests locally before submitting the PR.
It would make setup a lot easier for new contributers.

@rabeehrz

This comment has been minimized.

Copy link
Contributor

rabeehrz commented Feb 11, 2020

I think a section should be alloted for linting and compiling.
Running CSSLint and JSLint.
Compiling SCSS to CSS.

Also, a section explaining what purpose does a branch serve would be nice.

@williamdes

This comment has been minimized.

Copy link
Member Author

williamdes commented Feb 11, 2020

Thank you for all your comments ! 👍

NOTE: Inform contributors how much it is a bad idea of using main branches for PRs

F*** It did create #15754 (comment) ... 🤦‍♂

@williamdes williamdes force-pushed the williamdes:git-guide branch 4 times, most recently from c16b85e to 3ae8e70 Feb 13, 2020
@williamdes

This comment has been minimized.

Copy link
Member Author

williamdes commented Feb 13, 2020

@williamdes

This comment has been minimized.

Copy link
Member Author

williamdes commented Feb 13, 2020

@tabraiz961

.github/GIT_GUIDE.md Outdated Show resolved Hide resolved
.github/GIT_GUIDE.md Outdated Show resolved Hide resolved
@williamdes williamdes force-pushed the williamdes:git-guide branch from 3ae8e70 to 526c0cc Feb 14, 2020
@williamdes williamdes marked this pull request as ready for review Feb 14, 2020
[ci skip]

Signed-off-by: William Desportes <williamdes@wdes.fr>
@williamdes williamdes force-pushed the williamdes:git-guide branch from 526c0cc to a888fed Feb 23, 2020
@williamdes williamdes changed the title WIP: GIT guide Add a GIT manual Feb 23, 2020
@williamdes williamdes requested review from ibennetch and mauriciofauth Feb 23, 2020
@mauriciofauth

This comment has been minimized.

Copy link
Member

mauriciofauth commented Mar 2, 2020

Related to #14746

Copy link
Member

mauriciofauth left a comment

Some of this content can go to the CONTRIBUTING.md file and the rest can go to the Git wiki page.
Also I think we should keep the git commands as simple as possible and add a reference to the GitHub/Git documentation if the person wants to learn more about that command.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
pull-requests
  
In progress
Linked issues

Successfully merging this pull request may close these issues.

None yet

6 participants
You can’t perform that action at this time.