Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
92 lines (68 loc) · 4.05 KB

CONTRIBUTING.md

File metadata and controls

92 lines (68 loc) · 4.05 KB

Contributing

The project "*cloud - FileLink for Nextcloud and ownCloud" lives on GitLab: https://gitlab.com/joendres/filelink-nextcloud.

Reporting bugs and suggesting features

If you find a bug or have an idea for a feature:

  1. Go to the issues board and check if there is an open issue already.
  2. If there no issue describing your problem or your idea, there are two options to submit a new one:
    • Open a new issue on the issues board.
    • If you don't have a gitlab account, just send an e-mail to the Service Desk.

Pre-release versions

There usually are two development versions of *cloud:

  • Release-x.y.z for the next release that has new features or visible changes
  • Bugfix-x.y.z for the next release that only fixes bugs

These versions usually are more or less functional. They have corresponding branches in the repository.

All other branches are work in progress and guaranteed not to work 😉.

Localization / Translation

If you'd like to help translate *cloud into your language, there are several options.

Using Crowdin (preferred)

Localizations of *cloud are maintained as a Crowdin project. If you translate there, it's very easy for us to integrate your contributions into the next *cloud release.

Adding / Editing files

  1. Just download the english strings file
  2. Translate the messages in that file
    • Do not translate the description; they don't show up anywhere, they're just in there for your reference.
    • If you're not sure about a string's context, just put all your questions in an email or an issue. I'll be glad to clarify.
  3. Mail it to me or put it into an issue stating the language

Using Gitlab Merge Requests

If you already have a gitlab account and are familiar with the system, you can just fork, translate and create a merge request. But I will not directly merge those changes as they will conflict with the ones made on Crowdin. So if this is the easiest way for you, I'm fine with it.

Code

If you'd like to fix a bug or implement a feature

  • Just branch from the latest Release-x.y.z or Bugfix-x.y.z branch
  • Optional: When your code is ready, git merge the original branch and resolve conflicts. I'll handle all conflicts that arise later.
  • If you add strings, just add them to the english locales (and any other language you are fluent in), don't add english strings to other locales

Dev resources