Re: [myhdl-list] MyHDL development has moved to git & GitHub

[Christopher F. <chr...@gm...>]

On 2/22/15 10:41 AM, Jan Decaluwe wrote:
> On 02/22/2015 02:58 PM, Josy Boelen wrote:
>> I suppose that we have to *fork* the repository first.
>
> Mm, a fork is just a clone that GitHub knows about.
>
> For tracking development, a local clone is sufficient.
> No need to fork on GitHub first.
>
> To contribute changes, the guide mentions a fork on
> GitHub, to be able to raise pull requests.
>
> Is this too confusing?

No it is not too confusing, I think what exists is
sufficient.  But I could see the addition of a recommend
workflow using the personal github fork for contributions,
example:

    1. Fork on github

    2. Clone the personal fork
       >> git clone https://github.com/<username>/myhdl

    3. Create a branch for the development enhancement
       >> git checkout -b <branch name>

I think the branch is important (??) because github only
allows one fork whereas bitbucket-hg you would create many.
If you start an enhancement and it is abandoned, the
changes have to manually be unrolled vs. closing a branch
and creating a new branch from the sync'd master branch.

    4. To stay sync'd with the main repo add it as a
       remote
       >> git remote add <remote label> https://github.com/jandecaluwe/myhdl

    5. Sync when necessarily
       >> git fetch <remote label>

    6. Make changes and push to personal fork, when
       the changes are complete make sure the branch
       is sync'd with the main repo and create a PR.


I am still coming up to speed with git so the above
could be complete malarkey!  And what I don't know,
if branches are used for development, if the PR handles
everything (merging) or if it manually has to be merged
to the mainline (master) or should PRs always be to
the main branch.

Regards,
Chris