Skip to content

Commit 9794188

Browse files
author
Shauheen Zahirazami
committed
Update contribution guide and issue/PR templates
1 parent cde0d7d commit 9794188

File tree

3 files changed

+53
-0
lines changed

3 files changed

+53
-0
lines changed

CONTRIBUTING.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,26 @@
1+
# First things first: Welcome!
2+
3+
If you are here, it means you are interested in helping us out. A hearty welcome and thank you! We always welcome new contribution to any of the following areas:
4+
* Bug reports regarding the software or the documentation.
5+
* Documentation updates, tutorial and examples.
6+
* New code to implement a feature or patch an issue.
7+
8+
## Getting started:
9+
10+
Please join the community on [gitter](https://gitter.im/dotnet). Also please make sure to take a look at the project [roadmap](ROADMAP.md).
11+
12+
### Pull requests
13+
14+
If you are new to GitHub [here](https://help.github.com/categories/collaborating-with-issues-and-pull-requests/) is a detailed help source on getting involved with development on GitHub.
15+
16+
As a first time contributor, you will be invited to sign the Contributor License Agreement (CLA). Please follow the instructions of the dotnet foundation bot reviewer on your PR to sign the agreement. Please note that only original code with signed CLA could be merged into the main repo.
17+
18+
Your pull request needs to reference a filed issue. Please fill in the template that is populated for the pull request. Only pull requests adressing small typos can have no issues associated with them.
19+
20+
An ML.NET team member will be assigned to your pull request once the continuous integration checks have passed successfully.
21+
22+
All commits in a pull request will be squashed to a single commit with the original creator as author.
23+
124
# Contributing
225

326
See [Contributing](Documentation/project-docs/contributing.md) for information about coding styles, source structure, making pull requests, and more.

ISSUE_TEMPLATE.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
If you are filing an issue on GitHub, please ensure that it is a bug or a feature request or a major issue with the documentation. Also please take the time to fill out this form:
2+
3+
### System information
4+
5+
- **OS Platform and Distribution**:
6+
- **dot net version**:
7+
- **Exact steps to reproduce**:
8+
9+
### Describe the problem
10+
11+
Please use as much details as possible to explain why this is a bug or a feature request.
12+
13+
### Source code / logs
14+
15+
Please provide the code or logs or traces that would be helpful to diagnose the issue you are reporting.

PULL_REQUEST_TEMPLATE.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
Please ensure that the title for the pull request is meaningful and includes exactly what was done. Your pull request needs to reference a filed issue. Only pull requests adressing small typos can have no issues associated with them. Please use the following template:
2+
3+
```
4+
Issue #ISSUE_NUMBER THE_TITLE_OF_THE_PULL_REQUEST
5+
6+
This addressed the issue by
7+
* INSERT_DESCRIPTION_OF_SOMETHING
8+
* INSERT_DESCRIPTION_OF_SOMETHING_ELSE
9+
* ...
10+
11+
Issues:
12+
If your PR is addressing multiple issues, then list them all here.
13+
This closes #ISSUE_NUMBER
14+
This fixes #ISSUE_NUMBER
15+
```

0 commit comments

Comments
 (0)