mirror of
https://gitlab.com/libeigen/eigen.git
synced 2026-04-10 11:34:33 +08:00
Streamline merge request and bug templates.
This commit is contained in:
committed by
Rasmus Munk Larsen
parent
52358cb93b
commit
3abaabb999
@@ -1,42 +1,37 @@
|
|||||||
<!--
|
<!--
|
||||||
Please read this!
|
Thank you for submitting an issue!
|
||||||
|
|
||||||
Before opening a new issue, make sure to search for keywords in the issues
|
Before opening a new issue, please search for keywords in the existing [list of issues](https://gitlab.com/libeigen/eigen/-/issues?state=opened) to verify it isn't a duplicate.
|
||||||
filtered by "bug::confirmed" or "bug::unconfirmed" and "bugzilla" label:
|
-->
|
||||||
|
|
||||||
- https://gitlab.com/libeigen/eigen/-/issues?scope=all&utf8=%E2%9C%93&state=opened&label_name[]=bug%3A%3Aconfirmed
|
|
||||||
- https://gitlab.com/libeigen/eigen/-/issues?scope=all&utf8=%E2%9C%93&state=opened&label_name[]=bug%3A%3Aunconfirmed
|
|
||||||
- https://gitlab.com/libeigen/eigen/-/issues?scope=all&utf8=%E2%9C%93&state=opened&label_name[]=bugzilla
|
|
||||||
|
|
||||||
and verify the issue you're about to submit isn't a duplicate. -->
|
|
||||||
|
|
||||||
### Summary
|
### Summary
|
||||||
<!-- Summarize the bug encountered concisely. -->
|
<!-- Summarize the bug encountered concisely. -->
|
||||||
|
|
||||||
### Environment
|
### Environment
|
||||||
<!-- Please provide your development environment here -->
|
<!-- Please provide your development environment. -->
|
||||||
- **Operating System** : Windows/Linux
|
- **Operating System** : Windows/Linux
|
||||||
- **Architecture** : x64/Arm64/PowerPC ...
|
- **Architecture** : x64/Arm64/PowerPC ...
|
||||||
- **Eigen Version** : 3.3.9
|
- **Eigen Version** : 5.0.0
|
||||||
- **Compiler Version** : Gcc7.0
|
- **Compiler Version** : gcc-12.0
|
||||||
- **Compile Flags** : -O3 -march=native
|
- **Compile Flags** : -O3 -march=native
|
||||||
- **Vector Extension** : SSE/AVX/NEON ...
|
- **Vector Extension** : SSE/AVX/NEON ...
|
||||||
|
|
||||||
### Minimal Example
|
### Minimal Example
|
||||||
<!-- If possible, please create a minimal example here that exhibits the problematic behavior.
|
<!--
|
||||||
You can also link to [godbolt](https://godbolt.org). But please note that you need to click
|
Please create a minimal reproducing example here that exhibits the problematic behavior.
|
||||||
the "Share" button in the top right-hand corner of the godbolt page where you reproduce the sample
|
The example should be complete, in that it can fully build and run. See the [the guidelines on stackoverflow](https://stackoverflow.com/help/minimal-reproducible-example) for how to create a good minimal example.
|
||||||
code to get the share link instead of in your browser address bar.
|
|
||||||
|
|
||||||
You can read [the guidelines on stackoverflow](https://stackoverflow.com/help/minimal-reproducible-example)
|
You can also link to [godbolt](https://godbolt.org). Note that you need to click
|
||||||
on how to create a good minimal example. -->
|
the "Share" button in the top right-hand corner of the godbolt page to get the share link
|
||||||
|
instead of the URL in your browser address bar.
|
||||||
|
-->
|
||||||
|
|
||||||
```cpp
|
```cpp
|
||||||
//show your code here
|
// Insert your code here.
|
||||||
```
|
```
|
||||||
|
|
||||||
### Steps to reproduce
|
### Steps to reproduce the issue
|
||||||
<!-- Describe how one can reproduce the issue - this is very important. Please use an ordered list. -->
|
<!-- Describe the necessary steps to reproduce the issue. -->
|
||||||
|
|
||||||
1. first step
|
1. first step
|
||||||
2. second step
|
2. second step
|
||||||
@@ -49,21 +44,16 @@ on how to create a good minimal example. -->
|
|||||||
<!-- Describe what you should see instead. -->
|
<!-- Describe what you should see instead. -->
|
||||||
|
|
||||||
### Relevant logs
|
### Relevant logs
|
||||||
<!-- Add relevant code snippets or program output within blocks marked by " ``` " -->
|
<!-- Add relevant build logs or program output within blocks marked by " ``` " -->
|
||||||
|
|
||||||
<!-- OPTIONAL: remove this section if you are not reporting a compilation warning issue.-->
|
### [Optional] Benchmark scripts and results
|
||||||
### Warning Messages
|
|
||||||
<!-- Show us the warning messages you got! -->
|
|
||||||
|
|
||||||
<!-- OPTIONAL: remove this section if you are not reporting a performance issue. -->
|
|
||||||
### Benchmark scripts and results
|
|
||||||
<!-- Please share any benchmark scripts - either standalone, or using [Google Benchmark](https://github.com/google/benchmark). -->
|
<!-- Please share any benchmark scripts - either standalone, or using [Google Benchmark](https://github.com/google/benchmark). -->
|
||||||
|
|
||||||
### Anything else that might help
|
### Anything else that might help
|
||||||
<!-- It will be better to provide us more information to help narrow down the cause.
|
<!--
|
||||||
|
It will be better to provide us more information to help narrow down the cause.
|
||||||
Including but not limited to the following:
|
Including but not limited to the following:
|
||||||
- lines of code that might help us diagnose the problem.
|
- lines of code that might help us diagnose the problem.
|
||||||
- potential ways to address the issue.
|
- potential ways to address the issue.
|
||||||
- last known working/first broken version (release number or commit hash). -->
|
- last known working/first broken version (release number or commit hash).
|
||||||
|
-->
|
||||||
- [ ] Have a plan to fix this issue.
|
|
||||||
|
|||||||
@@ -1,6 +1,13 @@
|
|||||||
|
<!--
|
||||||
|
Thank you for submitting a Feature Request!
|
||||||
|
|
||||||
|
If you want to run ideas by the maintainers and the Eigen community first,
|
||||||
|
you can chat about them on the [Eigen Discord server](https://discord.gg/2SkEJGqZjR).
|
||||||
|
-->
|
||||||
|
|
||||||
### Describe the feature you would like to be implemented.
|
### Describe the feature you would like to be implemented.
|
||||||
|
|
||||||
### Would such a feature be useful for other users? Why?
|
### Why Would such a feature be useful for other users?
|
||||||
|
|
||||||
### Any hints on how to implement the requested feature?
|
### Any hints on how to implement the requested feature?
|
||||||
|
|
||||||
|
|||||||
@@ -1,26 +0,0 @@
|
|||||||
<!--
|
|
||||||
Thanks for contributing a merge request! Please name and fully describe your MR as you would for a commit message.
|
|
||||||
If the MR fixes an issue, please include "Fixes #issue" in the commit message and the MR description.
|
|
||||||
|
|
||||||
In addition, we recommend that first-time contributors read our [contribution guidelines](https://eigen.tuxfamily.org/index.php?title=Contributing_to_Eigen) and [git page](https://eigen.tuxfamily.org/index.php?title=Git), which will help you submit a more standardized MR.
|
|
||||||
|
|
||||||
Before submitting the MR, you also need to complete the following checks:
|
|
||||||
- Make one PR per feature/bugfix (don't mix multiple changes into one PR). Avoid committing unrelated changes.
|
|
||||||
- Rebase before committing
|
|
||||||
- For code changes, run the test suite (at least the tests that are likely affected by the change).
|
|
||||||
See our [test guidelines](https://eigen.tuxfamily.org/index.php?title=Tests).
|
|
||||||
- If possible, add a test (both for bug-fixes as well as new features)
|
|
||||||
- Make sure new features are documented
|
|
||||||
|
|
||||||
Note that we are a team of volunteers; we appreciate your patience during the review process.
|
|
||||||
|
|
||||||
Again, thanks for contributing! -->
|
|
||||||
|
|
||||||
### Reference issue
|
|
||||||
<!-- You can link to a specific issue using the gitlab syntax #<issue number> -->
|
|
||||||
|
|
||||||
### What does this implement/fix?
|
|
||||||
<!--Please explain your changes.-->
|
|
||||||
|
|
||||||
### Additional information
|
|
||||||
<!--Any additional information you think is important.-->
|
|
||||||
30
.gitlab/merge_request_templates/Merge Request.md
Normal file
30
.gitlab/merge_request_templates/Merge Request.md
Normal file
@@ -0,0 +1,30 @@
|
|||||||
|
<!--
|
||||||
|
Thanks for contributing a merge request!
|
||||||
|
|
||||||
|
We recommend that first-time contributors read our [contribution guidelines](https://eigen.tuxfamily.org/index.php?title=Contributing_to_Eigen).
|
||||||
|
|
||||||
|
Before submitting the MR, please complete the following checks:
|
||||||
|
- Create one PR per feature or bugfix,
|
||||||
|
- Run the test suite to verify your changes.
|
||||||
|
See our [test guidelines](https://eigen.tuxfamily.org/index.php?title=Tests).
|
||||||
|
- Add tests to cover the bug addressed or any new feature.
|
||||||
|
- Document new features. If it is a substantial change, add it to the [Changelog](https://gitlab.com/libeigen/eigen/-/blob/master/CHANGELOG.md).
|
||||||
|
- Leave the following box checked when submitting: `Allow commits from members who can merge to the target branch`.
|
||||||
|
This allows us to rebase and merge your change.
|
||||||
|
|
||||||
|
Note that we are a team of volunteers; we appreciate your patience during the review process.
|
||||||
|
-->
|
||||||
|
|
||||||
|
### Description
|
||||||
|
<!--Please explain your changes.-->
|
||||||
|
|
||||||
|
%{first_multiline_commit}
|
||||||
|
|
||||||
|
### Reference issue
|
||||||
|
<!--
|
||||||
|
You can link to a specific issue using the gitlab syntax #<issue number>.
|
||||||
|
If the MR fixes an issue, write "Fixes #<issue number>" to have the issue automatically closed on merge.
|
||||||
|
-->
|
||||||
|
|
||||||
|
### Additional information
|
||||||
|
<!--Any additional information you think is important.-->
|
||||||
Reference in New Issue
Block a user