Menu

#50 How to contribute?

v1.0 (example)
open
None
5
2020-09-25
2020-09-24
kjslkfjsd
No

I'm familiar with github developement, but have never tried contributing to anything on sourceforge until now. All I can seem to find is item 2.6 from the faq. I'm not familiar with the patch based development process, but the best example I could find is here. Does that link provide the same steps as are typically taken here?

I created a fork, and branch for improving one of the tutorials as I found it lacking references to the manual when I was going through it, leading to a lot of confusion. The fork and branch can be found here. It seems sourceforge does not have a feature to create pull requests from forks, so I'm at a loss for how to contribute these commits.

If there is a page dedicated to this process, please just provide me a link and I'm happy to read up on it myself. I've just not had any luck googling these topics and didn't find anything in the support search for "contribute", "contributions", "pull request", etc.

Related

Support Requests: #50

Discussion

  • Holger Vogt

    Holger Vogt - 2020-09-24
    • assigned_to: Holger Vogt
     
  • Holger Vogt

    Holger Vogt - 2020-09-24

    Maybe the best for now is if you submit a patch using diff like

    diff -ru originalfile editedfile > myPatch.diff
    

    to our patch tracker at https://sourceforge.net/p/ngspice/patches/. I would then review it and add it, if appropriate.

    Holger

     
  • kjslkfjsd

    kjslkfjsd - 2020-09-24

    Hi Holger,

    Thanks for the follow up.

    Is there any way of using git diff to compare between the master branch and tip of the branch in question rather than bash's diff? I've attached the output of git diff master ./ngspice-tutorial.html > myPatch.diff. I'm not sure about the formatting of the diff file itself, but the actual code differences should be identical.

    I don't keep copies of original files thus the syntax you provided would not be directly applicable, but I could regenerate the original file if this is truly the only method for patching like this. Do you have any recommended link to learn more about the patch-style development flow used here? It seems I'm trying to force git practices on something not suited for them.

    Also I'm afraid the diff file will look like quite a mess compared to viewing the indivudal commits I've made in my fork, which separate the differences into logical pieces with an explanation for each.

     
    • Holger Vogt

      Holger Vogt - 2020-09-24

      Yes, the diff is unreadable because it intermixes formatting and serious text modifications.

      Even if using git this is not recommended, better separate both in different commits.

       
      • kjslkfjsd

        kjslkfjsd - 2020-09-24

        Maybe I misunderstood what is needed. The diff that I sent was a
        combination of several commits. I have several commits in the git history
        which are item specific. You can see the different commits here. How is the
        best way to integrate these using the patch soureforge dev flow? Looks like
        the diffs are conveniently available per commit on the soureforge GUI. Is
        it necessary to provide a different diff for each commit then?

        On Thu, Sep 24, 2020 at 8:38 PM Holger Vogt h_vogt@users.sourceforge.net
        wrote:

        Yes, the diff is unreadable because it intermixes formatting and serious
        text modifications.

        Even if using git this is not recommended, better separate both in
        different commits.


        Status: open
        Group: v1.0 (example)
        Created: Thu Sep 24, 2020 04:11 AM UTC by kjslkfjsd
        Last Updated: Thu Sep 24, 2020 10:30 AM UTC
        Owner: Holger Vogt

        I'm familiar with github developement, but have never tried contributing
        to anything on sourceforge until now. All I can seem to find is item 2.6
        from the faq http://ngspice.sourceforge.net/faq.html. I'm not familiar
        with the patch based development process, but the best example I could find
        is here
        http://strasheela.sourceforge.net/strasheela/doc/HowToCreateAPatch.html.
        Does that link provide the same steps as are typically taken here?

        I created a fork, and branch for improving one of the tutorials as I found
        it lacking references to the manual when I was going through it, leading to
        a lot of confusion. The fork and branch can be found here
        https://sourceforge.net/u/sadkjfewroiu/ngspice/ci/ngspice-tutorial_updates/tree/.
        It seems sourceforge does not have a feature to create pull requests from
        forks, so I'm at a loss for how to contribute these commits.

        If there is a page dedicated to this process, please just provide me a
        link and I'm happy to read up on it myself. I've just not had any luck
        googling these topics and didn't find anything in the support search for
        "contribute", "contributions", "pull request", etc.


        Sent from sourceforge.net because you indicated interest in
        https://sourceforge.net/p/ngspice/support-requests/50/

        To unsubscribe from further messages, please visit
        https://sourceforge.net/auth/subscriptions/

         

        Related

        Support Requests: #50

        • Holger Vogt

          Holger Vogt - 2020-09-25
           
  • kjslkfjsd

    kjslkfjsd - 2020-09-25

    Thanks Holger. I guess I had misunderstood this and assumed you could not create a PR from a fork. The sourceforge GUI does not specify which fork you are refering to in the source and target, as well as you need to create the PR from the fork rather than the remote. These small differences along with the article led to all my confusion. Thank you for the video walking through this to clarify everything. Let me know if you have any other comments on the PR and commits so that I can make any necessary updates.

     

Log in to post a comment.

Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.