-
-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 4870acc
Showing
75 changed files
with
18,557 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# http://editorconfig.org | ||
root = true | ||
|
||
[*] | ||
indent_style = space | ||
indent_size = 4 | ||
end_of_line = lf | ||
charset = utf-8 | ||
trim_trailing_whitespace = true | ||
|
||
[*.csproj] | ||
indent_style = space | ||
indent_size = 2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# Auto detect text files and perform LF normalization | ||
* text=auto | ||
|
||
# Custom for Visual Studio | ||
*.cs diff=csharp | ||
*.sln merge=union | ||
*.csproj merge=union | ||
*.vbproj merge=union | ||
*.fsproj merge=union | ||
*.dbproj merge=union | ||
|
||
# Standard to msysgit | ||
*.doc diff=astextplain | ||
*.DOC diff=astextplain | ||
*.docx diff=astextplain | ||
*.DOCX diff=astextplain | ||
*.dot diff=astextplain | ||
*.DOT diff=astextplain | ||
*.pdf diff=astextplain | ||
*.PDF diff=astextplain | ||
*.rtf diff=astextplain | ||
*.RTF diff=astextplain |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
# Contributor Covenant Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
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. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to creating a positive environment include: | ||
|
||
* Using welcoming and inclusive language | ||
* Being respectful of differing viewpoints and experiences | ||
* Gracefully accepting constructive criticism | ||
* Focusing on what is best for the community | ||
* Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
* The use of sexualized language or imagery and unwelcome sexual attention or advances | ||
* Trolling, insulting/derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or electronic address, without explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a professional setting | ||
|
||
## Our Responsibilities | ||
|
||
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. | ||
|
||
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. | ||
|
||
## Scope | ||
|
||
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. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team. 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. | ||
|
||
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. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] | ||
|
||
[homepage]: http://contributor-covenant.org | ||
[version]: http://contributor-covenant.org/version/1/4/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,126 @@ | ||
# Contributing | ||
|
||
## Project Scope | ||
|
||
The AngleSharp project ultimately tries to provide tools to parse, inspect, modify and interact with traditional web resources, such as HTML or CSS, for .NET development. Anything that is related to this goal will be considered. The project aims to be fully standards compliant. If your contribution is not following the standard, the chances of accepting it are limited. | ||
|
||
## Code License | ||
|
||
This is an open source project falling under the MIT License. By using, distributing, or contributing to this project, you accept and agree that all code within the AngleSharp project are licensed under MIT license. | ||
|
||
## Becoming a Contributor | ||
|
||
Until the project has enough contributors a BDFL model is followed. As such the sole key maintainer keeps the right to appoint GitHub members as regular project contributors. Nevertheless, usually appointing someone follows this process: | ||
|
||
1. An individual contributes actively via discussions (reporting bugs, giving feedback to existing or opening new issues) and / or pull requests | ||
2. The individual is either directly asked, invited or asks for contributor rights on the project | ||
3. The individual uses the contribution rights to sustain or increase the active contributions | ||
|
||
Every contributor has to sign the contributor's license agreement (CLA) to establish a legal trust between the project and its contributors. | ||
|
||
## Working on AngleSharp | ||
|
||
### Issue Discussion | ||
|
||
Discussion of issues should be placed transparently in the [issue tracker](https://github.com/FlorianRappl/AngleSharp/issues/) here on GitHub. | ||
|
||
### Modifying the code | ||
|
||
AngleSharp uses features from C# 6 and will soon switch to C# 7. You will therefore need a C# compiler that is up for the job. | ||
|
||
1. Fork and clone the repo. | ||
2. First try to build the AngleSharp.Core libray and see if you get the tests running. | ||
3. You will be required to resolve some dependencies via NuGet. | ||
|
||
AngleSharp itself does not have dependencies, however, the tests are dependent on NUnit. | ||
|
||
The build system of AngleSharp uses Cake. A bootstrap script (build.ps1 for Windows or build.sh for *nix systems) is included. Note, that at the moment AngleSharp requires NuGet 3.5, which looks for MSBuild pre-15, i.e., before Visual Studio 2017 on Windows systems. | ||
|
||
### Code Conventions | ||
|
||
Most parts in the AngleSharp project are fairly straight forward. Among these are: | ||
|
||
- Always use statement blocks for control statements, e.g., in a for-loop, if-condition, ... | ||
- You may use a simple (throw) statement in case of enforcing contracts on argument | ||
- Be explicit about modifiers (some files follow an older convention of the code base, but we settled on the explicit style) | ||
|
||
There are a couple of rules, which are definitely not standard, but highly recommended for consistency and readability: | ||
|
||
- AngleSharp uses the RHS convention, where types are always put on the right hand side if possible, i.e., preferring `var` under all circumstances | ||
- A single empty line between two non-simple statements (e.g., for-loop and if-condition) should be inserted | ||
- Types are preferred to keywords (`String` instead of `string` or `Int32` instead of `int`) | ||
|
||
### Development Workflow | ||
|
||
1. If no issue already exists for the work you'll be doing, create one to document the problem(s) being solved and self-assign. | ||
2. Otherwise please let us know that you are working on the problem. Regular status updates (e.g. "still in progress", "no time anymore", "practically done", "pull request issued") are highly welcome. | ||
2. Create a new branch—please don't work in the `master` branch directly. It is reserved for releases. We recommend naming the branch to match the issue being addressed (`feature-#777` or `issue-777`). | ||
3. Add failing tests for the change you want to make. Tests are crucial and should be taken from W3C (or other specification). | ||
4. Fix stuff. Always go from edge case to edge case. | ||
5. All tests should pass now. Also your new implementation should not break existing tests. | ||
6. Update the documentation to reflect any changes. (or document such changes in the original issue) | ||
7. Push to your fork or push your issue-specific branch to the main repository, then submit a pull request against `devel`. | ||
|
||
Just to illustrate the git workflow for AngleSharp a little bit more we've added the following graphs. | ||
|
||
Initially AngleSharp starts at the `master` branch. This branch should contain the latest stable (or released) version. | ||
|
||
![AngleSharp Initial Master](https://github.com/AngleSharp/AngleSharp/wiki/initial-master.png) | ||
|
||
Here we now created a new branch called `devel`. This is the development branch. | ||
|
||
![AngleSharp Initial Devel](https://github.com/AngleSharp/AngleSharp/wiki/initial-devel.png) | ||
|
||
Now active work is supposed to be done. Therefore a new branch should be created. Let's create one: | ||
|
||
git checkout -b feature-#777 | ||
|
||
There may be many of these feature branches. Most of them are also pushed to the server for discussion or synchronization. | ||
|
||
git push -u origin feature-#777 | ||
|
||
At this point the graph could look as follows. The diagram shows two feature branches in different stages. | ||
|
||
![AngleSharp Feature Branches](https://github.com/AngleSharp/AngleSharp/wiki/feature-branches.png) | ||
|
||
Now feature branches may be closed when they are done. Here we simply merge with the feature branch(es). For instance the following command takes the `feature-#777` branch from the server and merges it with the `devel` branch. | ||
|
||
git checkout devel | ||
git pull | ||
git pull origin feature-#777 | ||
git push | ||
|
||
This aggregates to the graph below. | ||
|
||
![AngleSharp Merge Branches](https://github.com/AngleSharp/AngleSharp/wiki/feature-merges.png) | ||
|
||
Finally we may have all the features that are needed to release a new version of AngleSharp. Here we tag the release. For instance for the 1.0 release we use `v1.0`. | ||
|
||
git checkout master | ||
git merge devel | ||
git tag v1.0 | ||
|
||
Hence finally we have the full graph. | ||
|
||
![AngleSharp Release Git Graph](https://github.com/AngleSharp/AngleSharp/wiki/release.png) | ||
|
||
### Versioning | ||
|
||
The rules of [semver](http://semver.org/) don't necessarily apply here, but we will try to stay quite close to them. | ||
|
||
Prior to version 1.0.0 we use the following scheme: | ||
|
||
1. MINOR versions for reaching a feature milestone potentially combined with dramatic API changes | ||
2. PATCH versions for refinements (e.g. performance improvements, bug fixes) | ||
|
||
After releasing version 1.0.0 the scheme changes to become: | ||
|
||
1. MAJOR versions at maintainers' discretion following significant changes to the codebase (e.g., API changes) | ||
2. MINOR versions for backwards-compatible enhancements (e.g., performance improvements) | ||
3. PATCH versions for backwards-compatible bug fixes (e.g., spec compliance bugs, support issues) | ||
|
||
#### Code style | ||
|
||
Regarding code style like indentation and whitespace, **follow the conventions you see used in the source already.** In general most of the [C# coding guidelines from Microsoft](https://msdn.microsoft.com/en-us/library/ff926074.aspx) are followed. This project prefers type inference with `var` to explicitly stating (redundant) information. | ||
|
||
It is also important to keep a certain `async`-flow and to always use `ConfigureAwait(false)` in conjunction with an `await` expression. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# Issue Templates | ||
|
||
Please use one of the following templates to create your issue: | ||
|
||
- [BUG REPORT](https://github.com/AngleSharp/AngleSharp.Xml/issues/new?template=bugs.md) | ||
- [FEATURE PROPOSAL](https://github.com/AngleSharp/AngleSharp.Xml/issues/new?template=features.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
## Bug Report | ||
|
||
### Prerequisites | ||
|
||
- [ ] Can you reproduce the problem in a [MWE](https://en.wikipedia.org/wiki/Minimal_working_example)? | ||
- [ ] Are you running the latest version of AngleSharp? | ||
- [ ] Did you check the FAQs to see if that helps you? | ||
- [ ] Are you reporting to the correct repository? (if its an issue with the core library, please report to `AngleSharp` directly) | ||
- [ ] Did you perform a search in the issues? | ||
|
||
For more information, see the `CONTRIBUTING` guide. | ||
|
||
### Description | ||
|
||
[Description of the bug] | ||
|
||
### Steps to Reproduce | ||
|
||
1. [First Step] | ||
2. [Second Step] | ||
3. [and so on...] | ||
|
||
**Expected behavior:** [What you expected to happen] | ||
|
||
**Actual behavior:** [What actually happened] | ||
|
||
**Environment details:** [OS, .NET Runtime, ...] | ||
|
||
### Possible Solution | ||
|
||
[Optionally, share your idea to fix the issue] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
## New Feature Proposal | ||
|
||
### Description | ||
|
||
[Description of the proposed feature] | ||
|
||
### Background | ||
|
||
Provide any additional background for the feature. e.g., user scenarios. | ||
|
||
### Specification | ||
|
||
In case of updates that adhere to specification changes, please reference the used specification. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
## Types of Changes | ||
|
||
### Prerequisites | ||
|
||
Please make sure you can check the following two boxes: | ||
|
||
- [ ] I have read the **CONTRIBUTING** document | ||
- [ ] My code follows the code style of this project | ||
|
||
### Contribution Type | ||
|
||
What types of changes does your code introduce? Put an `x` in all the boxes that apply: | ||
|
||
- [ ] Bug fix (non-breaking change which fixes an issue, please reference the issue id) | ||
- [ ] New feature (non-breaking change which adds functionality, make sure to open an associated issue first) | ||
- [ ] Breaking change (fix or feature that would cause existing functionality to change) | ||
- [ ] My change requires a change to the documentation | ||
- [ ] I have updated the documentation accordingly | ||
- [ ] I have added tests to cover my changes | ||
- [ ] All new and existing tests passed | ||
|
||
### Description | ||
|
||
[Place a meaningful description here.] |
Oops, something went wrong.