Skip to content
This repository has been archived by the owner on Mar 24, 2023. It is now read-only.

Latest commit

 

History

History
75 lines (45 loc) · 3.67 KB

CONTRIBUTING.md

File metadata and controls

75 lines (45 loc) · 3.67 KB
Raw

Contribution Guide

Welcome to Rucio Desktop's contribution guide! Here are some things you need to keep in mind while contributing to this repository.

  • Please ensure that an issue exists before submitting your contribution as a pull request. Use the Standard Issue template for quick start.
  • The issue should contain the motivation, modification and expected results (discussions usually happen there).
  • No pull request will be merged without an associated issue (release notes are generated from issues).
  • You should make sure to add your name (and organisation) to AUTHORS.

A contribution can be either be a patch or feature:

  • Patches include bugfixes and minor changes to the code and are included in patch releases.

  • Features include major developments or potentially disruptive changes and are included in feature releases made multiple times a year.

Contribution steps

Pre-requisite: Setup a development environment by refering to the guide given here in our developer documentation. After completing that follow the steps below to create a PR in the repository.

STEP 1

If not exist, create an issue with the description of the contribution (motivation, modification and expected results). Every issue will get a unique issue number.

STEP 2

Create a local branch that corresponds to the issue. To easily identify the purpose of branches different keywords must be used:

  • Patch branches must be named patch-[issue number]-[short description]
  • Feature branches must be named feature-[issue number]-[short description]

STEP 3

Commit your change. The commit command must include a specific message format

$ git commit -m "<component>: <change_message> #<issue number>"

Valid component names are listed in the label list and are usually specified on the issue of the change.

NOTE: For first-time contributors, add your Name and Organisation in the AUTHORS.md file before creating a PR to the master branch. Follow the same format as previous contributors.

STEP 4

Push the commit to your forked repository and create the pull request from your created branch to rucio/desktop master

The format of the pull request title must be: <component>: <short_change_message> #<issue number>

You must mention the changes made in a bullet point format in the PR description. This helps the reviewers and other contributors getting a clear idea of the changes made by you in the codebase. In the end if the PR is intented to close an issue add this line:

This PR Fixes #<issue-number>

and mention the issue-number you are making the PR against. This shall help later in closing the issue automatically if the PR is merged.

STEP 5

Watch the pull request for comments and reviews. For any pull requests update, please try to squash/amend your commits to avoid "in-between" commits.

Coding Style

We use ESlint and Prettier to sanitize and format our code. The linting configuration is supplied alonf with the code. Please do use the same before submitting a pull request.

Help and Support

If you have questions, you can reach the development team on our Slack channel, or send an email to @viveknigam3003 or to our development mailing list [email protected].