Skip to content

GitLab

  • Menu
Projects Groups Snippets
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • airGR airGR
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 48
    • Issues 48
    • List
    • Boards
    • Service Desk
    • Milestones
  • Redmine
    • Redmine
  • Merge requests 3
    • Merge requests 3
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Monitor
    • Monitor
    • Incidents
  • Packages & Registries
    • Packages & Registries
    • Container Registry
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • HYCAR-Hydro
  • airGRairGR
  • Issues
  • #72

Closed
Open
Created Nov 24, 2020 by Dorchies David@david.dorchiesDeveloper

Add a CONTRIBUTING.md file to the repository

As several developers work on airGR, it would be a good idea to write development directives in an unified file.

Open source projects use a file named CONTRIBUTING.md which include these useful information. For details about the content of such a file, please have a look to: https://mozillascience.github.io/working-open-workshop/contributing/

It would be great to write some important information such as:

  • the workflow: the reporter create a ticket, the developper create a branch and a merge request and work on this branch, the manager merge the branch when the job is done
  • the syntax of the commit comments and the policy for versioning with how to fill the files DESCRIPTION and NEWS.md
  • the code syntax: "Capital CamelCase" for variables and functions, 2 spaces tabs, max line length, brackets on if statements...
  • the testing environment: how to test the package locally and how it is tested by Gitlab-CI
  • the release procedure: how to publish the package on CRAN?
Assignee
Assign to
Time tracking