From 097b36f9b0c1a7b603887e8512e10ca87cdd9c93 Mon Sep 17 00:00:00 2001 From: Ruben Date: Thu, 28 Nov 2024 15:06:51 +0100 Subject: [PATCH 1/2] PR template Signed-off-by: Ruben --- .github/PULL_REQUEST_TEMPLATE.md | 51 +------ CONTRIBUTING.md | 245 ------------------------------- 2 files changed, 8 insertions(+), 288 deletions(-) delete mode 100644 CONTRIBUTING.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b6b94634e3..43b3ebb6c1 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,47 +1,12 @@ - - Please fill in the information below to expedite the review - and (hopefully) merge of your change. +## Describe your changes - If unsure about something.. just do as best as you're able, - or reach out through our community support channels! - https://github.com/typeorm/typeorm/blob/master/docs/support.md ---> + -### Description of change +## Checklist before requesting a review - - - -### Pull-Request Checklist - - - -- [ ] Code is up-to-date with the `master` branch -- [ ] `npm run format` to apply prettier formatting -- [ ] `npm run test` passes with this change -- [ ] This pull request links relevant issues as `Fixes #0000` -- [ ] There are new or updated unit tests validating the change -- [ ] Documentation has been updated to reflect this change -- [ ] The new commits follow conventions explained in [CONTRIBUTING.md](https://github.com/typeorm/typeorm/blob/master/CONTRIBUTING.md) - - +- [ ] I have performed a self-review of my code +- [ ] I have added tests wherever relevant +- [ ] I have made sure that all automated checks pass before requesting a review +- [ ] I do not need any deviation from our PR guidelines diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 9361edd724..0000000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,245 +0,0 @@ -# Contributing to TypeORM - -We would love for you to contribute to TypeORM and help make it even better than it is today! -As a contributor, here are the guidelines we would like you to follow: - - - [Question or Problem?](#question) - - [Issues and Bugs](#issue) - - [Feature Requests](#feature) - - [Submission Guidelines](#submit) - - [Commit Message Format](#commit) - -## Got a Question or Problem? - -There are several ways how you can ask your question: - -* You can create a question on [StackOverflow](https://stackoverflow.com/questions/tagged/typeorm) where the questions should be tagged with tag `typeorm`. -* You can ask on [Slack](https://join.slack.com/t/typeorm/shared_invite/zt-uu12ljeb-OH_0086I379fUDApYJHNuw) -* You can create issue on [github](https://github.com/typeorm/typeorm/issues) -* If you have a Skype then try to find me there (`Umed Khudoiberdiev`) - -Preferred way if you create your question on StackOverflow, or create a github issue. - -## Found a security vulnerability? - -If you find a security vulnerability or something that should be discussed personally, -please contact me within my [email](https://github.com/typeorm/typeorm/blob/master/package.json#L10). - -## Found a Bug? - -If you find a bug in the source code, you can help us by [submitting an issue](#submit-issue) to our -[GitHub Repository](https://github.com/typeorm/typeorm). -Even better, you can [submit a Pull Request](#submit-pr) with a fix. - -## Missing a Feature? - -You can *request* a new feature by [submitting an issue](#submit-issue) to our GitHub -Repository. If you would like to *implement* a new feature, please submit an issue with -a proposal for your work first, to be sure that we can use it. -Please consider what kind of change it is: - -* For a **Major Feature**, first open an issue and outline your proposal so that it can be -discussed. This will also allow us to better coordinate our efforts, prevent duplication of work, -and help you to craft the change so that it is successfully accepted into the project. -* **Small Features** can be crafted and directly [submitted as a Pull Request](#submit-pr). - -## Submission Guidelines - -### Submitting an Issue - -Before you submit an issue, please search the issue tracker, -maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available. - -We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. - In order to reproduce bugs we ask you to provide a minimal code snippet that shows a reproduction of the problem. - -You can file new issues by filling out our [new issue form](https://github.com/typeorm/typeorm/issues/new). - -### Submitting a Pull Request (PR) -Before you submit your Pull Request (PR) consider the following guidelines: - -* Search [GitHub](https://github.com/typeorm/typeorm/pulls) for an open or closed PR - that relates to your submission. You don't want to duplicate effort. -* Make your changes in a new git branch: - - ```shell - git checkout -b my-fix-branch master - ``` - -* Create your patch, **including appropriate test cases**. Without tests your PR will not be accepted. -* Run the full TypeORM test suite, as described in the [developer documentation](DEVELOPER.md), and ensure that all tests pass. -* Commit your changes using a descriptive commit message that follows our [commit message conventions](#commit). Adherence to these conventions is necessary because release notes are automatically generated from these messages. - - ```shell - git commit -a - ``` - Note: the optional commit -a command line option will automatically "add" and "rm" edited files. - -* Push your branch to GitHub: - - ```shell - git push origin my-fix-branch - ``` - -* In GitHub, send a pull request to `typeorm:master`. -* If we suggest changes then: - * Make the required updates. - * Re-run the TypeORM test suites to ensure tests are still passing. - * Rebase your branch and force push to your GitHub repository (this will update your Pull Request): - - ```shell - git rebase master -i - git push -f - ``` - -That's it! Thank you for your contribution! - -#### After your pull request is merged - -After your pull request is merged, you can safely delete your branch and pull the changes -from the main (upstream) repository: - -* Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows: - - ```shell - git push origin --delete my-fix-branch - ``` - -* Check out the master branch: - - ```shell - git checkout master -f - ``` - -* Delete the local branch: - - ```shell - git branch -D my-fix-branch - ``` - -* Update your master with the latest upstream version: - - ```shell - git pull --ff upstream master - ``` - - -## Commit Message Guidelines - -We have very precise rules over how our git commit messages can be formatted. This leads to **more -readable messages** that are easy to follow when looking through the **project history**. But also, -we use the git commit messages to **generate changelog**. - -### Commit Message Format -Each commit message consists of a **header**, a **body** and a **footer**. The header has a special -format that includes a **type** and a **subject**: - -``` -: - - - -