Skip to content

Commit a6d2d8f

Browse files
committed
Add issue and PR templates.
Add a CONTRIBUTING.md and a section in the docs on contributing. Rm CONTRIBUTORS.md because it is outdated, redundant with Github stats and hard to maintain with the large amount of new contributors. Kept the PR template simple to not demotivate people from contributing, it could be improved with specialized templates in the future if necessary. In order to improve bug reports, we offer several templates for filing issues/bugs.
1 parent 4e08851 commit a6d2d8f

File tree

8 files changed

+196
-27
lines changed

8 files changed

+196
-27
lines changed
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve SLEEF
4+
title: ''
5+
labels: ''
6+
---
7+
8+
**Describe the bug**
9+
A clear and concise description of what the bug is.
10+
11+
**Command lines and logs**
12+
- CMake configuration AND build command
13+
- CMake configuration logs
14+
- CMake build logs (only the relevant part)
15+
16+
**To Reproduce**
17+
Always try to provide a reproducer, if applicable.
18+
- Link to a [Compiler Explorer](https://godbolt.org/) reproducer, if applicable.
19+
- Provide source code for reproducer along with command used to build reproducer.
20+
21+
**Expected behavior**
22+
A clear and concise description of what you expected to happen.
23+
24+
**Screenshots**
25+
If applicable, add screenshots to help explain your problem.
26+
27+
**Environment**
28+
- Is it a native build or cross-compilation?
29+
- Host/Target Architecture [e.g. x86_64 if native build, x86_64/aarch64 if cross build, ..]
30+
- OS with version [e.g. Linux/Ubuntu-22.04, Windows, macOS, iOS, ...]
31+
- CMake version [e.g. 3.18 , ...]
32+
- Makefile Generator [e.g. GNU Make, Ninja, ...]
33+
- Compiler with version [e.g. gcc-14, clang-18, apple-clang-15.2, msvc-15.0, ...]
34+
- If CUDA, please provide the version of the CUDA ToolKit.
35+
36+
**Additional context**
37+
Add any other context about the problem here.
38+

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 🗣 Ask a Question, Discuss
4+
url: https://github.com/shibatch/sleef/discussions
5+
about: Get help using SLEEF
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: Request Documentation
3+
about: Request a change or report an issue in documentation
4+
title: ''
5+
labels: ["doc"]
6+
---
7+
8+
**Where?**
9+
Where in the documentation did you notice an issue, e.g. README.md, `docs/*.md`, `sleef.org/*`, ...
10+
11+
**What?**
12+
What issue do you want to report? What change do you want to make?
13+
14+
**How?**
15+
A clear and concise description of what you want to happen.
16+
17+
**Additional context**
18+
Add any other context or screenshots about the issue here.
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Feature request
3+
about: Suggest a new feature or an idea for SLEEF
4+
title: ''
5+
labels: ''
6+
---
7+
8+
**Why a new feature? Is your feature request related to a problem? Please describe.**
9+
A clear and concise description of what the problem is, e.g.,
10+
- I'm always frustrated when [...]
11+
- [This program] that uses SLEEF fails [in some way], because it is failing to provide [...]
12+
13+
**What feature would you like?**
14+
A clear and concise description of what feature you want to introduce.
15+
Is it related to: algorithms, architecture specific code, build system, performance, accuracy, ...
16+
17+
**How would you like this feature to be implemented?**
18+
A clear and concise description of how you want the feature implemented.
19+
20+
**How portable is the feature across architectures and platforms?**
21+
A clear and concise description of potential portability issues.
22+
23+
**Describe alternative approaches you've considered**
24+
A clear and concise description of any alternative approaches you've considered.
25+
26+
**Additional context**
27+
Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
<!-- Thank you for contributing! -->
2+
3+
# Checklist
4+
5+
- [ ] I have read the [contributing guidelines](https://github.com/shibatch/sleef/blob/HEAD/CONTRIBUTING.md).
6+
- [ ] In particular, I have considered portability of my change across platforms and architectures.
7+
- [ ] I have self-reviewed my code.
8+
- [ ] I have commented my code where necessary.
9+
- [ ] I have updated the documentation accordingly.
10+
- [ ] I have added tests that prove my fix is effective or that my feature works.
11+
12+
# What is the purpose of this pull request?
13+
14+
<!-- Keep the line(s) that apply. -->
15+
16+
* Fix a bug
17+
* Improve code quality or performance
18+
* Add support for a new vector extension
19+
* Add a workflow to GitHub Actions or add/modify a job in an existing workflow
20+
* Documentation update
21+
* Other, please explain:
22+
23+
# What changes did you make?
24+
25+
<!-- Give an overview of the change. -->
26+
27+
# Does this PR relate to any existing issue?
28+
29+
Relates to/Fixes # (issue)
30+
31+
# Is there anything you would like reviewers to focus on?
32+
33+
Please on focus on...

CONTRIBUTING.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Contributing
2+
3+
Please be sure to read the contribution guidelines before making or requesting a change.
4+
5+
## Design Principles
6+
7+
Before anything please consider what are the main design principle of SLEEF:
8+
9+
1. Portability across platforms and architectures
10+
2. Compliance to C99 standard
11+
3. Best performance of vector implementation of branchless and lookup-free algorithms
12+
13+
## Filing Issues
14+
15+
Before filing an issue, please be sure to read the guidelines for what you are reporting:
16+
17+
* [Report Bugs](https://sleef.org/contribute#report-bugs)
18+
* [Request Feature](https://sleef.org/contribute#request-feature)
19+
* [Request a Change in Documentation](https://sleef.org/contribute#request-documentation)
20+
21+
## Contributing Code or Documentation
22+
23+
Before submitting code or documentation to SLEEF, please read over the [Pull Request Guidelines](https://sleef.org/contribute#pull-requests).
24+
25+
## Full Documentation
26+
27+
Our full contribution guidelines can be found at: <https://sleef.org/contribute>

CONTRIBUTORS.md

Lines changed: 0 additions & 27 deletions
This file was deleted.

docs/6-contribute/README.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
layout: default
3+
title: Contribute
4+
nav_order: 7
5+
permalink: /6-contribute/
6+
---
7+
8+
# Contribute to SLEEF
9+
{:toc}
10+
11+
## Discussions
12+
13+
If you have a question that does not necessarily require a change to SLEEF,
14+
such as asking how something works or how to contribute, please [open a
15+
discussion](https://github.com/shibatch/sleef/discussions/new/choose) instead.
16+
17+
## Templates
18+
19+
By using the provided issues or pull-request template you make sure we have all
20+
the information we need to triage, understand and solve your issue as quickly
21+
and efficiently as we can. Please help us by providing as much information as
22+
you can by filing the provided forms.
23+
24+
## Report Bug
25+
26+
If you would like to report a bug in SLEEF, please [create a new
27+
issue](https://github.com/shibatch/sleef/issues/new) and select [Report
28+
Bugs](https://github.com/shibatch/sleef/issues/new?template=bug_report.md).
29+
You can also suggest a fix by [submitting a pull
30+
request](https://github.com/shibatch/sleef/pulls) on GitHub.
31+
32+
## Request Feature
33+
34+
If you would like to request a feature or a change to SLEEF, please [create a
35+
new issue](https://github.com/shibatch/sleef/issues/new) and select [Request
36+
Features](https://github.com/shibatch/sleef/issues/new?template=feature_request.md).
37+
38+
## Request Documention
39+
40+
If you would like to report an issue or request a change to the documentation,
41+
please [create a new issue](https://github.com/shibatch/sleef/issues/new) and
42+
select [Request
43+
Docs](https://github.com/shibatch/sleef/issues/new?template=docs_request.md).
44+
45+
## Pull Requests
46+
47+
If you would like to suggest a fix or any change to SLEEF, please [submit a
48+
pull request](https://github.com/shibatch/sleef/pulls) on GitHub.

0 commit comments

Comments
 (0)