Skip to content
This repository was archived by the owner on May 15, 2024. It is now read-only.

Commit c2a54b0

Browse files
author
Dave Humphreys
committed
Initial attempt at contribution, submission docs, and templates
Initial attempt at contribution, submission docs, and templates
1 parent c709e88 commit c2a54b0

5 files changed

+169
-0
lines changed

CODE_OF_CONDUCT.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Code of Conduct
2+
3+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.

CONTRIBUTING.md

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Contributing
2+
3+
Thanks you for your interest in contributing to Microsoft Caboodle! In this document we'll outline what you need to know about contributing and how to get started.
4+
5+
## Code of Conduct
6+
7+
Please see our [Code of Conduct](CODE_OF_CONDUCT.md).
8+
9+
## Prerequisite
10+
11+
You will need to complete a Contribution License Agreement before any pull request can be accepted. Complete the CLA at https://cla2.dotnetfoundation.org/.
12+
13+
## Contributing Code
14+
15+
Check out [A Beginner's Guide for Contributing to Microsoft Caboodle](https://blog.xamarin.com/beginners-guide-contributing-xamarin-forms/).
16+
17+
### Bug Fixes
18+
19+
If you're looking for something to fix, please browse [open issues](https://github.com/xamarin/Caboodle/issues).
20+
21+
Follow the style used by the [.NET Foundation](https://github.com/dotnet/corefx/blob/master/Documentation/coding-guidelines/coding-style.md), with two primary exceptions:
22+
23+
- We do not use the `private` keyword as it is the default accessibility level in C#.
24+
- We use hard tabs over spaces. You can change this setting in VS 2015 via `Tools > Options` and navigating to `Text Editor > C#` and selecting the "Keep tabs" radio option.
25+
26+
Read and follow our [Pull Request template](https://github.com/xamarin/Caboodle/blob/master/PULL_REQUEST_TEMPLATE.md)
27+
28+
### Proposals
29+
30+
To propose a change or new feature, review the guidance below and then [open an issue using this template](https://github.com/xamarin/Caboodle/issues).
31+
32+
#### Non-Starter Topics
33+
The following topics should generally not be proposed for discussion as they are non-starters:
34+
35+
* Large renames of APIs
36+
* Large non-backward-compatible breaking changes
37+
* Platform-Specifics which can be accomplished without changing Microsoft Caboodle
38+
* Avoid clutter posts like "+1" which do not serve to further the conversation
39+
40+
#### Proposal States
41+
##### Open
42+
Open proposals are still under discussion. Please leave your concrete, constructive feedback on this proposal. +1s and other clutter posts which do not add to the discussion will be removed.
43+
44+
##### Accepted
45+
Accepted proposals are proposals that both the community and core Microsoft Caboodle agree should be a part of Microsoft Caboodle. These proposals are ready for implementation, but do not yet have a developer actively working on them. These proposals are available for anyone to work on, both community and the core Microsoft Caboodle team.
46+
47+
If you wish to start working on an accepted proposal, please reply to the thread so we can mark you as the implementor and change the title to In Progress. This helps to avoid multiple people working on the same thing. If you decide to work on this proposal publicly, feel free to post a link to the branch as well for folks to follow along.
48+
49+
###### What "Accepted" does mean
50+
* Any community member is welcome to work on the idea.
51+
* The core Microsoft Caboodle team _may_ consider working on this idea on their own, but has not done so until it is marked "In Progress" with a team member assigned as the implementor.
52+
* Any pull request implementing the proposal will be welcomed with an API and code review.
53+
54+
###### What "Accepted" does not mean
55+
* The proposal will ever be implemented, either by a community member or by the core Microsoft Caboodle team.
56+
* The core Microsoft Caboodle team is committing to implementing a proposal, even if nobody else does. Accepted proposals simply mean that the core Microsoft Caboodle team and the community agree that this proposal should be a part of Microsoft Caboodle.
57+
58+
##### In Progress
59+
Once a developer has begun work on a proposal, either from the core Microsoft Caboodle team or a community member, the proposal is marked as in progress with the implementors name and (possibly) a link to a development branch to follow along with progress.
60+
61+
#### Rejected
62+
Rejected proposals will not be implemented or merged into Microsoft Caboodle. Once a proposal is rejected, the thread will be closed and the conversation is considered completed, pending considerable new information or changes..

ISSUE_TEMPLATE.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
Bug report best practices: [Submitting Issues](SUBMITTING-ISSUES.md)
2+
3+
### Description
4+
5+
### Steps to Reproduce
6+
7+
1.
8+
2.
9+
3.
10+
11+
### Expected Behavior
12+
13+
### Actual Behavior
14+
15+
### Basic Information
16+
17+
- Version with issue:
18+
- Last known good version:
19+
- IDE:
20+
- Platform Target Frameworks: <!-- All that apply -->
21+
- iOS: <!-- The version of the iOS SDK you are compiling against, e.g. 11.1 -->
22+
- Android: <!-- The version of the Android SDK you are compiling against, e.g. 7.1 -->
23+
- UWP: <!-- The version of the UWP SDK you are compiling against, e.g. 16299 -->
24+
- Android Support Library Version: <!-- if applicable -->
25+
- Nuget Packages:
26+
- Affected Devices:
27+
28+
### Screenshots
29+
30+
<!-- If the issue is a visual issue, please include screenshots showing the problem if possible -->
31+
32+
### Reproduction Link
33+
34+
<!-- Please upload or provide a link to a reproduction case -->

PULL_REQUEST_TEMPLATE.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
### Description of Change ###
2+
3+
Describe your changes here.
4+
5+
### Bugs Fixed ###
6+
7+
- Provide links to bugs here
8+
9+
### API Changes ###
10+
11+
List all API changes here (or just put None), example:
12+
13+
Added:
14+
15+
- string - string Class.Property { get; set; }
16+
- void Class.Method();
17+
18+
Changed:
19+
20+
- object Cell.OldPropetyName => object Cell.NewPropetyName
21+
22+
### Behavioral Changes ###
23+
24+
Describe any non-bug related behavioral changes that may change how users app behaves when upgrading to this version of the codebase.
25+
26+
### PR Checklist ###
27+
28+
- [ ] Has tests (if omitted, state reason in description)
29+
- [ ] Rebased on top of master at time of PR
30+
- [ ] Changes adhere to coding standard
31+
- [ ] Consolidate commits as makes sense

SUBMITTING-ISSUES.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
If you think you've found a bug to report, before doing anything else you should check the [Issues](https://github.com/xamarin/Caboodle/issues) page to see if an issue has already been filed! This can help reduce the number of duplicate reports.
2+
3+
If you're ready to submit a new issue, taking the following steps helps expedite the bug triage process:
4+
5+
* Validate that the issue is not resolved with the latest stable, pre-release, or nightly builds.
6+
7+
* If you are able and time allows, create a minimized reproduction project using only the code necessary to reproduce the issue; this helps us as we then know precisely what code is being used.
8+
9+
* Before compressing the reproduction project, make certain to clean the solution as well as manually delete any bin/obj folders, e.g.:
10+
11+
[ProjectRoot]/ProjectName/bin
12+
[ProjectRoot]/ProjectName/obj
13+
[ProjectRoot]/ProjectName.Android/bin
14+
[ProjectRoot]/ProjectName.Android/obj
15+
[ProjectRoot]/ProjectName.iOS/bin
16+
[ProjectRoot]/ProjectName.iOS/obj
17+
[ProjectRoot]/ProjectName.UWP/bin
18+
[ProjectRoot]/ProjectName.UWP/obj
19+
20+
Please make certain to remove the packages folder as well to cut down on size.
21+
22+
* Please make note if the issue only occurs on particular platforms, so we can run reproductions on each and compare.
23+
24+
* In the case of a regression, please confirm as such as well as the last working, pre-regression build you may be aware of, if possible. Providing a reproduction with the working package installed to begin with also helps, as we can then simply upgrade it and compare against the latest stable to confirm.
25+
26+
* In some cases, issues may only occur on specific devices, with specific versions of the OS, or when targeting specific OS versions within the project itself. Some issues also occur on devices, but not on simulators. This information is incredibly helpful.
27+
28+
* Please upload reproductions directly to the report as an attachment; this guarantees future access to the file.
29+
30+
#Android Specific Concerns#
31+
Please let us know any issues which may stem from different versions of the support library packages (e.g. Xamarin.Android.Support.v7.AppCompat), as sometimes bugs may only occur when specific versions are used.
32+
iOS Specific Concerns
33+
To be added
34+
35+
#UWP-specific Concerns#
36+
Please make note if an issue appears hardware-specific (slower machines, multiple monitors, etc.), due to the desktop component.
37+
38+
#Contributing#
39+
Think you may have a bug fix, or you'd like to work on fixing one yourself? We greatly welcome PRs with fixes from the community! Check out the [Contribute page](CONTRIBUTING.md) for more info.

0 commit comments

Comments
 (0)