forked from DIRACGrid/Pilot
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
49 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
Contributing to DIRAC/Pilot | ||
=========================== | ||
|
||
:+1::tada: First off, thanks for taking the time to contribute! :tada::+1: | ||
|
||
Feel free to propose changes to this document in a pull request. | ||
|
||
Repository structure | ||
==================== | ||
|
||
Due to the fact that we support only the production and the development versions, | ||
for now only 2 branchs are present: *master*, and *devel*. | ||
|
||
* *master* is the stable branch. Production tags are created starting from this branch. | ||
* *devel* is the development branch. Tags created starting from this branch are subject to a certification process. | ||
|
||
The following diagram highlights the interactions between the branches and the merging and tagging strategy: | ||
 | ||
|
||
For now, actually there are no tags created yet, so we've always used the HEAD of the branches. | ||
|
||
Repositories | ||
============ | ||
|
||
Developers should have 2 remote repositories (which is the typical GitHub workflow): | ||
|
||
* *origin* : cloned from your private fork done on GitHub | ||
* *upstream* : add it via git remote add upstream and pointing to the blessed repository: [email protected]:DIRACGrid/Pilot.git (or https://github.com/DIRACGrid/Pilot.git using https protocol) | ||
|
||
Issue Tracking | ||
============== | ||
|
||
Issue tracking for the project is [here in github](https://github.com/DIRACGrid/Pilot/issues). | ||
|
||
|
||
Code quality | ||
============ | ||
|
||
The contributions are subject to reviews. | ||
|
||
Pylint is run regularly on the source code. The .pylintrc file defines the expected coding rules and peculiarities. | ||
|
||
|
||
Testing | ||
====== | ||
|
||
Unit tests are provided within the source code. Integration, regression and system tests are instead in the tests directory. | ||
|
||
|