Skip to content

Latest commit

 

History

History
34 lines (20 loc) · 1.48 KB

CONTRIBUTING.md

File metadata and controls

34 lines (20 loc) · 1.48 KB

Contributing

Contributions are warmly welcomed! To avoid any misunderstandings, do please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before submitting a PR.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Environment Setup

This repository makes use of the SASjs framework for code organisation, compilation, documentation, and deployment. The following tools are highly recommended:

  • NPM - the runtime and dependency manager for SASjs CLI (batteries included)
  • VSCode - feature packed IDE for code editing (warning - highly effective!)
  • GIT - a safety net you cannot (and should not) do without.

For generating the documentation (sasjs doc) it is also necessary to install doxygen.

To get configured:

  1. Clone the repository
  2. Install local dependencies (npm install)
  3. Install the SASjs CLI globally (npm install -g @sasjs/cli)

To contribute:

  1. Create your feature branch (git checkout -b myfeature)
  2. Make your change
  3. Commit the change, using the conventional commit standard
  4. Push and make a PR

Create documentation:

sasjs doc