Skip to content

Commit 39d7ff0

Browse files
committed
Merge remote-tracking branch 'upstream/develop/3.0' into feature/approved
2 parents c04608f + ffe9563 commit 39d7ff0

22 files changed

+242
-327
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
# Summary
11+
A summary of the issue you're experiencing.
12+
13+
# Steps to reproduce
14+
- Platform: Mobile/Desktop
15+
- Framework Version: .NET Core 3, .NET 4.8, Xamarin Android 8.1
16+
- API: Vulkan/OpenGL
17+
- API Version: Vulkan 1.2/OpenGL 4.3 Legacy/OpenGL 4.5 Core/OpenGLES 3.2
18+
1. First I did this
19+
2. Then I did this
20+
21+
# Comments
22+
Add any other context about the problem here.
23+
24+
**__If you know how to fix this issue, please submit a pull request instead!__**
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
name: Everything else
3+
about: If you don't think you issue fits in to any of the categories, use this template.
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
# Summary of feature
10+
A clear and concise description of what you want to happen.
11+
12+
# Comments
13+
14+
# Does this have a proposal?
15+
Check the documentation/proposals folder. If it doesn't have one, you may need to create one if you're making **massive breaking changes**.

.github/pull_request_template.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Summary of the PR
2+
A short summary of this PR and what it adds/removes/fixes.
3+
4+
# Related issues, Discord discussions, or proposals
5+
Links go here.
6+
7+
# Further Comments

Directory.Build.props

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<PropertyGroup>
1515
<BaseArtifactsPath>$(MSBuildThisFileDirectory)artifacts/</BaseArtifactsPath>
1616
<BaseArtifactsPathSuffix>$(ProjectCategory)/$(MSBuildProjectName)</BaseArtifactsPathSuffix>
17-
<RepositoryUrl>https://github.com/Perksey/SilkX</RepositoryUrl>
17+
<RepositoryUrl>https://github.com/dotnet/Silk.NET</RepositoryUrl>
1818
</PropertyGroup>
1919

2020
<!-- Default settings that explicitly differ from the Sdk.props defaults -->
@@ -40,8 +40,8 @@
4040
<BaseOutputPath>$(BaseArtifactsPath)bin/$(BaseArtifactsPathSuffix)/</BaseOutputPath>
4141
<Company>.NET Foundation</Company>
4242
<PackageOutputPath>$(BaseArtifactsPath)pkg/$(BaseArtifactsPathSuffix)/$(Configuration)/</PackageOutputPath>
43-
<Product>SilkX</Product>
44-
<VersionPrefix>0.1.0</VersionPrefix>
43+
<Product>Silk.NET</Product>
44+
<VersionPrefix>3.0.0</VersionPrefix>
4545
<VersionSuffix>alpha</VersionSuffix>
4646
</PropertyGroup>
4747

build.cmd

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

build.sh

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

docs/CODEOWNERS

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
###############################################################################
22
# Default owner for all files in the repository
33
###############################################################################
4-
* @Perksey
4+
* @dotnet/silk-dotnet

docs/CODE_OF_CONDUCT.md

Lines changed: 4 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,6 @@
1-
# Contributor Covenant Code of Conduct
1+
# Code of Conduct
22

3-
## Our Pledge
3+
This project has adopted the code of conduct defined by the Contributor Covenant
4+
to clarify expected behavior in our community.
45

5-
In the interest of fostering an open and welcoming environment, we as
6-
contributors and maintainers pledge to making participation in our project and
7-
our community a harassment-free experience for everyone, regardless of age, body
8-
size, disability, ethnicity, gender identity and expression, level of
9-
experience, nationality, personal appearance, race, religion, or sexual identity
10-
and orientation.
11-
12-
## Our Standards
13-
14-
Examples of behavior that contributes to creating a positive environment
15-
include:
16-
17-
* Using welcoming and inclusive language
18-
* Being respectful of differing viewpoints and experiences
19-
* Gracefully accepting constructive criticism
20-
* Focusing on what is best for the community
21-
* Showing empathy towards other community members
22-
23-
Examples of unacceptable behavior by participants include:
24-
25-
* The use of sexualized language or imagery and unwelcome sexual attention or
26-
advances
27-
* Trolling, insulting/derogatory comments, and personal or political attacks
28-
* Public or private harassment
29-
* Publishing others' private information, such as a physical or electronic
30-
address, without explicit permission
31-
* Other conduct which could reasonably be considered inappropriate in a
32-
professional setting
33-
34-
## Our Responsibilities
35-
36-
Project maintainers are responsible for clarifying the standards of acceptable
37-
behavior and are expected to take appropriate and fair corrective action in
38-
response to any instances of unacceptable behavior.
39-
40-
Project maintainers have the right and responsibility to remove, edit, or reject
41-
comments, commits, code, wiki edits, issues, and other contributions that are
42-
not aligned to this Code of Conduct, or to ban temporarily or permanently any
43-
contributor for other behaviors that they deem inappropriate, threatening,
44-
offensive, or harmful.
45-
46-
## Scope
47-
48-
This Code of Conduct applies both within project spaces and in public spaces
49-
when an individual is representing the project or its community. Examples of
50-
representing a project or community include using an official project e-mail
51-
address, posting via an official social media account, or acting as an appointed
52-
representative at an online or offline event. Representation of a project may be
53-
further defined and clarified by project maintainers.
54-
55-
## Enforcement
56-
57-
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58-
reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
59-
complaints will be reviewed and investigated and will result in a response that
60-
is deemed necessary and appropriate to the circumstances. The project team is
61-
obligated to maintain confidentiality with regard to the reporter of an
62-
incident. Further details of specific enforcement policies may be posted
63-
separately.
64-
65-
Project maintainers who do not follow or enforce the Code of Conduct in good
66-
faith may face temporary or permanent repercussions as determined by other
67-
members of the project's leadership.
68-
69-
## Attribution
70-
71-
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
72-
version 1.4, available at
73-
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
74-
75-
[homepage]: https://www.contributor-covenant.org
6+
For more information, see the [.NET Foundation Code of Conduct](https://dotnetfoundation.org/code-of-conduct).

docs/CONTRIBUTING.md

Lines changed: 47 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,63 @@
1-
# Contributing to SilkX
1+
# Contributing
22

3-
The following is a set of guidelines for contributing to SilkX.
3+
You can contribute to Silk.NET with issues and PRs. Simply filing issues for problems you encounter is a great way to contribute. Contributing code is also greatly appreciated.
44

5-
TODO: Link social media channels here
5+
## Considerations
6+
The Silk.NET team will merge changes that improve the library significantly. We will not merge changes that have narrowly-defined benefits, or are breaking in some way. All contributions must also follow all other guidelines outlined in this document.
67

7-
## Table of Contents
8+
## DOs and DON'Ts
9+
Please:
10+
- **DO** talk to us in #team-talk in the Discord or open a discussion issue if your contribution is sizeable.
11+
- **DO** keep the discussions around contributions focused. If you have another matter to discuss, rather than creating a massive tangent in the current discussion, open up a new one.
12+
- **DO** follow the code of conduct if discussing on GitHub and/or the Discord #rules if discussing on Discord.
13+
- **DON'T** make PRs that don't directly affect the end user, such as style changes. These are best done as part of a PR related to the area in question. Documentation is fine (and encouraged!), as this is useful to the end user.
14+
- **DON'T** commit code you didn't write without following its license and following our guidelines for doing so in the Contributor License Agreement. If you are unable to license some code, don't commit it.
15+
- **DON'T** surprise us with big pull requests or big API changes without talking to us first!
16+
- **DON'T** make PRs for legal or administrative documents, such as the license, file headers, or code of conduct. If you see something off, let us know and we'll change it.
817

9-
* [Code of Conduct](#code-of-conduct)
10-
* [License](#license)
11-
* [What should I know?](#what-should-i-know)
12-
* [Pull Requests](#pull-requests)
13-
* [Issues](#issues)
14-
* [Questions](#questions)
18+
## Breaking changes
19+
Contributions must maintain API signature and behavioral compatibility. Contributions that include breaking changes will be rejected. There are exceptions to this, such as if the contribution is made against a major/breaking version branch (such as `2.0` instead of `master`), however this is subject to the team's approval. At risk of sounding like a broken record, talk to us about your idea first!
1520

16-
### Code of Conduct
21+
### Generated bindings
22+
Sometimes upstream specification changes happen while working on your contribution. Unfortunately, we are not in control of breaking changes created by the upstream spec sources, and if one happens while working on your contribution it is not a cause for concern.
1723

18-
This project has adopted the code of conduct defined by the [Contributor Covenant](http://contributor-covenant.org/)
19-
to clarify expected behavior in our community. For more information, see the [.NET Foundation Code of Conduct](http://www.dotnetfoundation.org/code-of-conduct).
24+
If your contribution affects binder output, let us know by commenting on the pull request. If the change isn't as a result of your modifications to the BuildTools (if any), it is recommended that you don't commit the .gen.cs files and instead do this in a separate PR.
2025

21-
### License
26+
## Suggested workflow
27+
Silk.NET uses and encourages [Early Pull Requests](https://medium.com/practical-blend/pull-request-first-f6bb667a9b6). Please don't wait until you're done to open a PR!
2228

23-
Copyright © .NET Foundation and Contributors. Licensed under the MIT License
24-
(MIT). See [LICENSE](LICENSE.md) in the repository root for more information.
29+
1. Install [Git](https://git-scm.com/downloads) and the [.NET Core SDK](https://www.microsoft.com/net/download)
30+
1. [Fork Silk.NET](https://github.com/dotnet/Silk.NET/fork)
31+
1. Create a branch on your fork.
32+
1. Add an empty commit to start your work off (and let you open a PR): `git commit --allow-empty -m "start of [thing you're working on]"`
33+
1. Open a [**draft pull request**](https://github.blog/2019-02-14-introducing-draft-pull-requests/). Do this **before** you actually start working.
34+
1. Make your commits in small, incremental steps with clear descriptions.
35+
1. Tag a maintainer when you're done and ask for a review!
2536

26-
### What should I know?
37+
## "Help wanted" & "Good first issue"
38+
If the core team are unable to champion an issue, they will mark it with a "help wanted" label. This indicates that any external contributor may pick up on this issue and implement it as part of a contribution. However, some "help wanted" issues may require intermediate knowledge of the codebase, area, and/or ecosystem; or may have uncertainty surrounding implementation details (if this is the case talk to us in the Discord or in a discussion issue). Because of this, we also mark some issues with the label "good first issue" which indicates that an issue is straightforward, and is a good place to start if you're interested in contributing but new to the codebase.
2739

28-
Most of the basics of the project, such as what it is about, and its goals are
29-
covered in our [README](docs/README.md).
40+
## Contributor License Agreement
41+
You must sign a Contributor License Agreement (CLA) before your PR will be merged. This is a one-time requirement for all .NET Foundation projects, and you'll only have to do this once. You can read more about [Contribution License Agreements (CLAs) on Wikipedia](https://en.wikipedia.org/wiki/Contributor_License_Agreement).
3042

31-
### Pull Requests
43+
You don't have to do this up-front. You can simply clone, fork, and submit your pull-request as usual. When your pull-request is created, you'll be notified by the CLA bot of further instructions if necessary.
3244

33-
All pull requests should follow our
34-
[PULL_REQUEST_TEMPLATE](docs/PULL_REQUEST_TEMPALTE.md). It is additionally
35-
recommended that an issue be opened, discussed, and approved first to ensure
36-
that the change will be accepted. Any pull requests not following pull request
37-
template will be requested to be updated. Any pull requests opened without a
38-
corresponding issue may be delayed or be required to undergo further changes
39-
before being accepted.
45+
## File Headers
46+
The following file header is used for Silk.NET. Please use it for new files.
47+
```cs
48+
// Licensed to the .NET Foundation under one or more agreements.
49+
// The .NET Foundation licenses this file to you under the MIT license.
50+
```
4051

41-
### Issues
52+
## Pull requests
53+
### Continuous Integration
54+
Our GitHub Actions Continuous Integration (CI) system will automatically perform the required builds, tests, and in some cases changes for Pull Requests (PRs).
4255

43-
All issues should follow our [ISSUE_TEMPLATE](ISSUE_TEMPLATE.md). It is
44-
additionaly recommended to prefix your issue with an appriopriate "tag" such as
45-
`[QUESTION]`, `[BUG]`, `[REGRESSION]`, `[IDEA]`, or `[PROPOSAL]`.
56+
If the CI build fails for any reason, you can view the logs to find out what the problem is. In some cases, GitHub Actions will highlight the errors inline on the "File Changes" tabs.
4657

47-
### Questions
58+
### Feedback
59+
Team and community members will provide feedback on your change. Community feedback is highly valued. You will often see the absence of team feedback if the community has already provided good review feedback.
4860

49-
Feel free to open an issue prefixed with `[QUESTION]`.
61+
One or more team members will review every PR prior to merge.
62+
63+
There are lots of thoughts and approaches for how to efficiently discuss changes. It is best to be clear and explicit with your feedback. Please be patient with people who might not understand the finer details about your approach to feedback.

0 commit comments

Comments
 (0)