Skip to content
This repository has been archived by the owner on Jul 12, 2024. It is now read-only.

Latest commit

 

History

History
61 lines (40 loc) · 3.36 KB

CONTRIBUTING.md

File metadata and controls

61 lines (40 loc) · 3.36 KB
Raw

Contributing to Mockoon-commons

Guidelines from Mockoon's main repository must be followed. Specific guidelines below applies to this repository:

Application dependence

@mockoon/commons is a library used by Mockoon main application and Mockoon's CLI.

Dependence between the three projects is highly probable, and having to contribute solely to this repository may be possible but rare.

Therefore, contributions to this repository should most of the time stem from a parent's issue (bug or feature) opened in the main application's or the CLI's repositories.

Environment

This library contains mostly typings and migrations designed to be used in both the browser and Node.js environments. Thus, it is safe to use it in Electron main or renderer processes, and the CLI.

Contribution rules

The following rules apply to all contributions:

  • Always search among the opened and closed issues. Assigned issues are already being worked on, and, most of the time, cannot be reassigned.
  • Bug reports, enhancements, and features must be discussed with the maintainers regarding the implementation, changes to the UI, etc.
  • Pull requests must refer to an open issue which must itself stem from a main repository's issue. Pull requests not solving existing issues may not be accepted.
  • Issues and PR must follow the provided templates.

Build and run the application

Prerequisites

Some of the build steps require the Linux rm command. If you are buliding on Windows and this command is not in your path you will need to install it. Possible ways to do this are:

  • Install git for Windows and include the commands in the path.
  • Use Cmder as your terminal.
  • Use WSL.

Build steps

  • Clone the repository: [email protected]:mockoon/commons.git.
  • You will also need the main Mockoon app repository cloned: [email protected]:mockoon/mockoon.git.
  • Run npm install to install dependencies.
  • Run npm run build to build the commons package.
  • In the Mockoon app directory, run npm link ./path/to/local/mockoon/commons to install your newly built commons package.
  • Follow the build and run instructions for the main application.

Run the unit tests and the linter before submitting pull requests. (npm run test and npm run lint). Run the Prettier extension to format code before submitting. Either via the VSCode extension, or on the command line (npx prettier --write ./path/to/code-file.ts)

Work on your feature or bugfix

  • Start your feature or fix from main
  • Preferably squash your commits, except when it makes sense to keep them separate (one refactoring + feature development)
  • Do not forget to add "Closes #xx" in one of the commit messages or in the pull request description (where xx is the GitHub issue number)

Branches naming convention:

  • features and enhancements: feature/name-or-issue-number
  • bug fixes: fix/name-or-issue-number

Open a pull request

Open a pull request to be merge in the main branch. All branches should start from main and must be merged into main. Ask maintainers to review the code and be prepared to rework your code if it does not match the style or do not follow the way it's usually done (typing, reducer, etc).