Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Fabiopf02 authored Nov 11, 2023
1 parent 3789cd0 commit 6e9dbb7
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Contributing

Thank for taking the time to check out the repo and be willing to contribute!

If you have found an issue or would like to request a new feature, simply create a new issue. Be sure to fill out as much information as possible.

## Reporting Bugs & Feature Requests

If you would like to submit a feature request or report a bug, we encourage you to first look through the [issues](https://github.com/Fabiopf02/ofx-data-extractor/issues) and [pull requests](https://github.com/Fabiopf02/ofx-data-extractor/pulls) before filing a new issue.

## Submitting a Pull Request

If you wish to submit a pull request for a new feature or issue, you should start by forking this repository first. This should get you setup on your local machine:

### Setup

- Install [Node.js](https://nodejs.org/) if you have not already
- Fork the repo
- `git clone https://github.com/*yourusername*/ofx-data-extractor.git && cd ofx-data-extractor`
- `npm install`
- `npm run test`

One you have done this, create a new branch with a name that loosely describes the issue on which you will be working. Once you think you have the addressed the issue in question, submit a pull request to the `main` branch.

0 comments on commit 6e9dbb7

Please sign in to comment.