Pull request composed of few commits

[Paolo Valleri]

Hi all,

for a better tractability of the contribution, a while ago I have read in this forum about avoiding creating pull-request composed of several commits; I am totally inline with that but I am not such git expert :(, I am wondering if it is possible to recede this list https://github.com/ilvalle/web2py/compare/preference-tab?expand=1 into one single commit.

Moreover, shall we create a wiki page on github with main advice about how to contribute (code style, indentation, variable names etc)?

Paolo

[Niphlod]

this http://gun.io/blog/how-to-github-fork-branch-and-pull-request/ helps.

Basically you fork and maintain your forked master branch in sync with the "official" repository (that's usually named "upstream").

All you work needs to be done in a "fresh" topic branch. Before sending PRs, you should:

- check that your master is in sync with upstream

- squash your commits so they get down to 1 commit only (and it is a so-called fast-forward merge, i.e. ready to be applied to master) 

- push that topic branch to your repo

and then initiate a PR from that one.

In that way we have a reduced fuss graph and the merge is a one shot line.

[Massimo DiPierro]

I think we need this. How about we put in the book Introduction?

--
-- mail from:GoogleGroups "web2py-developers" mailing list
make speech: web2py-d...@googlegroups.com
unsubscribe: web2py-develop...@googlegroups.com
details : http://groups.google.com/group/web2py-developers
the project: http://code.google.com/p/web2py/
official : http://www.web2py.com/
---
You received this message because you are subscribed to the Google Groups "web2py-developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to web2py-develop...@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.
 
 

[Niphlod]

ok, add in the todo-list :D

[Roberto Perdomo]

Maybe a chapter named "How to contribute with Web2py" and topics like:

- Coding style.
- Send pull request and Github.
- Typos in the book.
- Helping users in the group.

[Massimo Di Pierro]

- how to report security issues

[Anthony]

In my document, there is this:

For advanced users, it can be very helpful to explore the source code. It may be useful to provide an overview of what’s in various gluon modules and maybe walk through the control flow for a typical request.

If we add a chapter about contributing, perhaps something like the above could go in there.

We could also articulate some principles regarding what makes a good code contribution (makes the code smaller, faster, etc.; comes with tests and documentation).

Anthony

[Massimo Di Pierro]

+1