Skip to content

Commit 3c61e1a

Browse files
committed
Added PR template and point to templates in contributing.md
Refs #62
1 parent 3088a1c commit 3c61e1a

File tree

3 files changed

+26
-25
lines changed

3 files changed

+26
-25
lines changed

.github/ISSUE_TEMPLATE/20_feature_request.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,6 @@ assignees: ''
77

88
---
99

10-
10+
- Explain in detail how it would work.
11+
- Keep the scope as narrow as possible, to make it easier to implement.
12+
- Remember that this is a volunteer-driven project, and that contributions are welcome :)

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Pull Request Guidelines
2+
3+
* * *
4+
5+
Before you submit a pull request, check that it meets these guidelines:
6+
7+
1. Tests described in [TESTING.md](TESTING.md) should continue to pass.
8+
1. If the pull request adds functionality, it is good practice to also add tests for the functionality.
9+
1. Update the [CHANGELOG](CHANGELOG.md) in accordance with the nature of your Pull Request.
10+
1. The pull request should work for C++, emscripten, web browser, Python 3.6, 3.7 and 3.8.
11+
A continuous integration job will run tests for you.
12+
Check green check mark on [https://github.com/NLESC-JCER/cpp2wasm/pulls](https://github.com/NLESC-JCER/cpp2wasm/pulls)
13+
and make sure that the tests pass.
14+
15+
If you need help with any of the tasks above, please do not hesitate to ask by commenting in the issue or pull request.
16+
17+
* * *
18+
19+
Closes {Link to the corresponding issue}

CONTRIBUTING.md

Lines changed: 4 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,7 @@ You can contribute in many ways:
2323

2424
### Report Bugs
2525

26-
Report bugs at [https://github.com/NLESC-JCER/cpp2wasm/issues](https://github.com/NLESC-JCER/cpp2wasm/issues).
27-
28-
If you are reporting a bug, please include:
29-
30-
- Your operating system name and version.
31-
- Any details about your local setup that might be helpful in troubleshooting.
32-
- Detailed steps to reproduce the bug.
26+
Report bugs at [https://github.com/NLESC-JCER/cpp2wasm/issues/new?labels=bug&template=10_bug_report.md](https://github.com/NLESC-JCER/cpp2wasm/issues/new?labels=bug&template=10_bug_report.md).
3327

3428
### Fix Bugs
3529

@@ -45,12 +39,7 @@ and "help wanted" is open to whoever wants to implement it.
4539

4640
The best way to send feedback is to file an issue at [https://github.com/NLESC-JCER/cpp2wasm/issues](https://github.com/NLESC-JCER/cpp2wasm/issues).
4741

48-
If you are proposing a feature:
49-
50-
- Explain in detail how it would work.
51-
- Keep the scope as narrow as possible, to make it easier to implement.
52-
- Remember that this is a volunteer-driven project, and that contributions
53-
are welcome :)
42+
If you are proposing a feature go [here](https://github.com/NLESC-JCER/cpp2wasm/issues/new?labels=enhancement&template=20_feature_request.md).
5443

5544
## Get Started!
5645

@@ -60,7 +49,7 @@ Ready to contribute? Here's how to set up `cpp2wasm` for local development.
6049
2. Clone your fork locally::
6150

6251
```shell
63-
git clone git@github.com:your_name_here/cpp2wasm.git
52+
git clone https://github.com/your_name_here/cpp2wasm.git
6453
```
6554

6655
3. Install the dependencies as listed in [INSTALL.md#dependencies](INSTALL.md#dependencies).
@@ -99,16 +88,7 @@ Ready to contribute? Here's how to set up `cpp2wasm` for local development.
9988
10089
## Pull Request Guidelines
10190
102-
Before you submit a pull request, check that it meets these guidelines:
103-
104-
1. The pull request should include tests.
105-
1. If the pull request adds functionality, the docs should be updated. Put
106-
your new functionality into a function with a docstring, and add the
107-
feature to the list in README.rst.
108-
1. Update the [CHANGELOG](CHANGELOG.md) in accordance with the nature of your Pull Request.
109-
1. The pull request should work for C++, emscripten, web browser, Python 3.6, 3.7 and 3.8. A continuous integration job will run tests for you. Check
110-
green check mark on https://github.com/NLESC-JCER/cpp2wasm/pulls
111-
and make sure that the tests pass.
91+
See [.github/PULL_REQUEST_TEMPLATE.md](.github/PULL_REQUEST_TEMPLATE.md) for guidelines.
11292
11393
## Tips
11494

0 commit comments

Comments
 (0)