Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MOL-550: Add contribution guidelines #91

Merged
merged 1 commit into from
Oct 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions docs/contribution/ContributionGuidelines.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Contribution Guide

* [Prerequisites](#prerequisites)
* [Development](#development)

## Prerequisites

To merge your changes, your commits must be [signed](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits).

Minimum requirements are:
- **Node.js** version 18
- **Npm** npm v10.7.0
- **Bash** shell
- **Signed** git commits

You can install all dependencies using `npm` with following command:

```
npm install
```

## Development
While developing project you can use some predefined commands for running tests, running linter or generating coverage.

- Execute `npm run test` to run all tests.
- Execute `npm run lint` to show lint errors in the code.

## Release procedure
At the moment there is no automated release scripts, which means we do releases manually. We use [gitflow workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) for releases. Please **squash commits when finishing the feature branch**, this way we can keep relatively clean history on develop and main.

Contributing by following these steps:

1. Create and check out a new branch off main and make your necessary change here. The branch name should have a specific prefix depends on the purpose, e.g: `bugfix/`, `feat/`
2. Bump [version](https://semver.org/) on npm package (in /processor). Commit changes on the above branch.
3. Create PR and wait for the approval from the development team.
26 changes: 26 additions & 0 deletions docs/contribution/IssueTemplate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Issue Template

**Deployment**
_My deployment is on:_

- [ ] Docker
- [ ] AWS Lambda
- [ ] GCP
- [ ] Azure
- [ ] Other _Please specify:_

**Expected behaviour**

_Please explain what should happen._

**Actual behaviour**

_Please explain what is happening instead. Provide a log message if relevant._

**Attempted fixes**

_Please explain what you've done so far to try and fix the problem._

**Please provide more information about how this can be reproduced. Please include jsfiddle links, code snippets or any other necessary information**

_Include extra info here._