CONTRIBUTING.md

Contributing to typeorm-model-generator

• Question or Problem?
• Submission Guidelines

Got a Question or Problem?

• You can create issue on github
• While this tool doesn't have separate separate chat room you can use typeorm slack workspace since everyone using typeorm-model-generator will also use typeorm.

Submission Guidelines

Submitting an Issue

Before submitting new issue, please check the issue tracker, maybe your problem is already described and the discussion might inform you of available workarounds.

Before fixing a bug we need to reproduce and confirm it. In order to reproduce bugs, we will ask you to provide a minimal reproduction. Having a minimal reproducible scenario gives us a wealth of important information without going back & forth to you with additional questions. A minimal reproduction allows us to quickly confirm a bug (or point out a coding problem) as well as confirm that we are fixing the right problem.

Submitting a Pull Request (PR)

Before you submit your Pull Request (PR) consider the following guidelines:

1. Search GitHub for an open or closed PR that relates to your submission. You don't want to duplicate effort.

2. Make your changes in a new git branch:

   git checkout -b my-fix-branch master

3. Create your patch.

4. Run test suite and ensure that all tests pass.

5. Commit your changes using a descriptive commit message.

6. Push your branch to GitHub:

   git push origin my-fix-branch

7. In GitHub, send a pull request to typeorm-model-generator:master.

• If we suggest changes then:
  • Make the required updates.
  • Re-run test suites to ensure tests are still passing.
  • Push to your GitHub repository (this will update your Pull Request)

Note: if you don't want to run tests on your machine you can rely on tests run on CI (unless you're changing something oracledb specific).

That's it! Thank you for your contribution!