Skip to content

Improvement for CONTRIBUTING.md #59

@gegeweb

Description

@gegeweb

Actual version of CONTRIBUTING.md is verry short!


Contribute

Thanks for your support! Please open a pull request on GitHub!


I based myself on this rule when starting to work on the French translation, you can see what kind of misunderstanding it caused! ;)

I propose (i could open a MR if you agree) something like (not sure for my english!):


Contribute to the documentation

Thanks for your support! You're welcome!

  • First, take a look at the issues to check if there already one on the same subject.
    If yes, you can join the discussion adding your comment.

  • If no, start by openning a new issue with your proposal.

  • Then, you can submit your merge request with your adds or changes following the rules explained here and below:

    • If not doing yet, fork this repository
    • create a new branch from the up to date changes branch
    • make your changes
    • push the new branch into your repository
    • submit the merge request linking to the opened issue from your branch to the changesbranch.
    • wait for the review and the merge…

DO NOT MERGE YOUR WORK into your local changesbranch, only keep it in sync by pooling from the remote Jamulus repository.
DO NOT WORK ON your local changes branch, always works from a new branch.
If the changesbranch is modified before submitting your request, keep the local changesbranch in sync by pooling from it, merge the local changes branch into your working branch, resolve conflicts and then push your changes and create the merge request.

Please note that all the discussions are in English. If it is not you're native language and are not fluent with it, it can dissuade you. Don't be afraid, you can use DeepL wich make good translations as a help support.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions