Skip to content

Latest commit

 

History

History
41 lines (27 loc) · 1.38 KB

CONTRIBUTING.md

File metadata and controls

41 lines (27 loc) · 1.38 KB
Raw

Contributing to js-dataverse

First of all thank you very much for your interest in contributing to this project!

Getting started

  1. Fork the repository and clone your fork locally
  2. Follow the Local Development guide for setting up your local development environment
  3. Create a branch and apply the desired changes on it
  4. Create a pull request from your fork branch targeting the develop branch of the root repository

Checklist before creating PR

  • Project builds
  • Lint and format checks pass
  • Unit and integration tests pass
  • Unit and integration tests for new functionality/fix are added
  • Documentation is updated (Any new use case added or modified should be documented in the Use Cases section)

Code of Conduct

We abide by the upstream Code of Conduct at https://github.com/IQSS/dataverse/blob/develop/CODE_OF_CONDUCT.md and in addition ask the following.

Git

  • Branch names are self descriptive
  • Commit messages are short and concise
  • Branch is put up to date before creating PR

Our responsibilities

  • To keep the code clean
  • To provide constructive feedback to other developers
  • To maintain readable code at all times

Getting help

Please, do not hesitate to contact us through: