Skip to content

Commit

Permalink
fix: updated old README and CONTRIBUTING
Browse files Browse the repository at this point in the history
  • Loading branch information
fstagni committed Jun 5, 2024
1 parent ec39e15 commit 138d371
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 88 deletions.
33 changes: 2 additions & 31 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,39 +11,10 @@ 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:
![LHCbDIRAC branches](https://docs.google.com/drawings/d/14UPBPGW2R8d7JBO9eHWw2tyD3ApEuUBmlDEFicoBs1U/pub?w=1011&h=726)

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: git@github.com:DIRACGrid/Pilot.git (or https://github.com/DIRACGrid/Pilot.git using https protocol)
* *master* is the stable branch.
* *devel* is the development branch.

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.


8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Dirac Pilots

The Dirac interware is a software framework for distributed computing,
providing a complete solution to one or more user community requiring access to distributed resources.
Dirac builds a layer between the users and the resources offering a common interface to a number of heterogeneous providers,
integrating them in a seamless manner, providing interoperability, at the same time as an optimized, transparent and reliable usage of the resources.

The Pilot repository is an independent part of the Dirac system dedicated to the development of Dirac Pilots.
57 changes: 0 additions & 57 deletions README.rst

This file was deleted.

0 comments on commit 138d371

Please sign in to comment.