Skip to content
This repository was archived by the owner on Mar 16, 2025. It is now read-only.

Commit a7f0e9b

Browse files
Merge branch 'release-1.1.0' into main
2 parents 7ed8108 + fe77d28 commit a7f0e9b

File tree

2,102 files changed

+56167
-59224
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

2,102 files changed

+56167
-59224
lines changed

.github/CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @henrikfroehling

.github/ISSUE_TEMPLATE.md

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

.github/ISSUE_TEMPLATE/Custom.md

Lines changed: 0 additions & 22 deletions
This file was deleted.
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: bug, library
6+
assignees: henrikfroehling
7+
8+
---
9+
10+
**GitHub Issues are only used for bug reports and feature requests.**
11+
12+
**If you have a support question, please ask in the official Gitter Chat:** https://gitter.im/Trakt-NET/Lobby
13+
14+
**Please follow these guidelines when creating a new issue:**
15+
16+
**--- Please use this template, and delete everything above this line before submitting your issue ---**
17+
18+
**Describe the bug**
19+
- Use a **descriptive title** that identifies the issue to be addressed.
20+
- Specify a **detailed description** of the issue.
21+
- Specify the **version of Trakt.NET**, in which the bug occurs.
22+
- Specify the platform only, if the bug is related to a specific platform.
23+
- Describe the **expected and actual behavior**.
24+
- Specify any relevant **exception messages** and **stack traces**.
25+
- Describe the steps on how to reproduce the bug.
26+
- Subscribe for notifications for the created issue in case there are any follow up questions.
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: 'feature-request, library, target-branch: develop'
6+
assignees: henrikfroehling
7+
8+
---
9+
10+
**GitHub Issues are only used for bug reports and feature requests.**
11+
12+
**If you have a support question, please ask in the official Gitter Chat:** https://gitter.im/Trakt-NET/Lobby
13+
14+
**Please follow these guidelines when creating a new issue:**
15+
16+
**--- Please use this template, and delete everything above this line before submitting your issue ---**
17+
18+
**Is your feature request related to a problem? Please describe.**
19+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
20+
21+
**Describe the solution you'd like**
22+
A clear and concise description of what you want to happen.
23+
24+
**Describe alternatives you've considered**
25+
A clear and concise description of any alternative solutions or features you've considered.
26+
27+
**Additional context**
28+
Add any other context about the feature request here.

AUTHORS.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
Trakt.NET is primarily authored by:
22

3-
* [Henrik Fröhling](https://github.com/henrikfroehling) [(henrik.froehling@gmail.com)](mailto:henrik.froehling@gmail.com)
3+
* [Henrik Fröhling](https://github.com/henrikfroehling) [(henrik.froehling@gmail.com)](mailto:henrik.froehling@gmail.com)
44

55
Contributors include:
66

7-
* [Romans Pokrovskis](https://github.com/Amoenus) [(romans.pokrovskis@capita.co.uk)](mailto:romans.pokrovskis@capita.co.uk)
7+
* [Romans Pokrovskis](https://github.com/Amoenus)
8+
* [MCs88](https://github.com/MCs88)
9+
* [Arnaud Maichac](https://github.com/arnaudmaichac)
10+
* [skyfrk](https://github.com/skyfrk)

CODE_OF_CONDUCT.md

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

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

CONTRIBUTING.md

Lines changed: 21 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -11,55 +11,40 @@ Contributing Guidelines
1111

1212
---
1313

14-
### **Currently, there are the following limits on submitting pull requests**
15-
- Contributions must be discussed with the maintainer first by opening an issue, or they will likely be declined.
16-
- Only contributions against the [develop](https://github.com/henrikfroehling/Trakt.NET/tree/develop)-branch will be accepted. Authors submitting pull requests that target experimental feature branches or the [master](https://github.com/henrikfroehling/Trakt.NET/tree/master)-branch will likely be asked to target their pull request against the develop-branch.
17-
- Pull requests that do not merge easily with the tip of the develop-branch will be declined. The author will be asked to merge with the tip of the targeted branch and update the pull request.
18-
- Submissions must meet funtional expectations, including scenarios for which the maintainer does not yet have open source tests. This means you may be asked to fix and resubmit your pull request against a new open test case if it fails one of these tests.
19-
- Submissions must follow the rules stated in the [Coding Guidelines](https://github.com/henrikfroehling/Trakt.NET/blob/develop/coding_style.md).
20-
- Contributions must follow the [additional requirements](https://github.com/henrikfroehling/Trakt.NET/blob/develop/CONTRIBUTING.md#additional-requirements-for-pull-requests).
14+
### **Getting started**
15+
1. Create your own fork of the repository
16+
2. Do the changes in your fork
17+
- Create a branch for the change with a descriptive name.
18+
3. If you like your change, send a pull request
19+
- Be sure you have followed the [FAQ](https://github.com/henrikfroehling/Trakt.NET/blob/develop/CONTRIBUTING.md#faq)
20+
- Be sure you have followed the [General Requirements](https://github.com/henrikfroehling/Trakt.NET/blob/develop/CONTRIBUTING.md#general-requirements)
2121

2222
---
2323

24-
### **Additional requirements for pull requests**
25-
- Ensure [cross-platform compatibility](https://github.com/henrikfroehling/Trakt.NET/blob/develop/CONTRIBUTING.md#cross-platform-compatibility) for new features.
26-
- New features must have accompanying [unit tests](https://github.com/henrikfroehling/Trakt.NET/blob/develop/CONTRIBUTING.md#unit-tests) with "good" code coverage.
27-
- Changes to existing functionality needs to be checked that it does not break any existing [unit tests](https://github.com/henrikfroehling/Trakt.NET/blob/develop/CONTRIBUTING.md#unit-tests).
24+
### **Build Requirements**
25+
- at least Visual Studio 2017 with support for C# 7.2
2826

2927
---
3028

31-
### **Coding conventions**
32-
- Use the coding style outlined in the [Coding Guidelines](https://github.com/henrikfroehling/Trakt.NET/blob/develop/coding_style.md).
33-
- Use plain code to validate arguments at public boundaries. Do not use contracts or magic helpers.
34-
```csharp
35-
if (argument == null)
36-
throw new ArgumentNullException(nameof(argument), "optional message");
37-
```
38-
- Use `Debug.Assert()` for checks not needed in release builds. Always include a "message" string in your assert to identify failure conditions.
29+
### **FAQ**
30+
1. **Q: Which branch should I target?**
3931

40-
---
32+
_A: By default you should target the branch `develop`. If you're working on an issue, usually the issue would have a label "target-branch", which states the branch to target for that specific issue._
33+
2. **Q: How do I trigger a CI-Build for my pull request?**
4134

42-
### **Getting started**
43-
1. Create your own fork of the repository
44-
2. Do the changes in your fork
45-
- Create a branch for the change with a descriptive name.
46-
3. If you like the change:
47-
- Be sure you have followed the [Coding Guidelines](https://github.com/henrikfroehling/Trakt.NET/blob/develop/coding_style.md).
48-
- Be sure you have followed the [additional requirements](https://github.com/henrikfroehling/Trakt.NET/blob/develop/CONTRIBUTING.md#additional-requirements-for-pull-requests).
49-
- Send a pull request
35+
_A: To trigger a CI-Build for you Pull Request branch, you should name your branch in the following pattern: `issue/{target-branch-name}/{your-branch-name}`, e.g. `issue/develop/your-branch-name`._
5036

5137
---
5238

53-
### **Build requirements**
54-
- at least Visual Studio 2017 with support for C# 7.2
39+
### **General Requirements**
40+
- Do not make big surprise pull requests with a lot of changes and without an associating issue.
41+
- First, please open an issue to open a discussion, whether your changes do make an actual improvement.
42+
- Pull requests that do not merge easily with the tip of the develop-branch will be declined. The author will be asked to merge with the tip of the targeted branch and update the pull request.
43+
- Submissions must follow the rules stated in the [Coding Guidelines](https://github.com/henrikfroehling/Trakt.NET/blob/develop/coding_style.md).
44+
- New features must have accompanying tests with "good" code coverage.
45+
- Changes to existing functionality needs to be checked that it does not break any existing unit tests.
5546

5647
---
5748

5849
### **Cross-platform compatibility**
5950
- [Trakt.NET](https://github.com/henrikfroehling/Trakt.NET) is built against .NET Standard 1.1
60-
61-
---
62-
63-
### **Unit Tests**
64-
- all new tests need to be added to the project `Trakt.NET.Tests`
65-
- the test framework is XUnit

0 commit comments

Comments
 (0)