|
| 1 | +# Contributing |
| 2 | + |
| 3 | +## Project Scope |
| 4 | + |
| 5 | +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. |
| 6 | + |
| 7 | +## Code License |
| 8 | + |
| 9 | +This is an open source project falling under the [MIT License](../LICENSE). By using, distributing, or contributing to this project, you accept and agree that all code within the AngleSharp project and its libraries are licensed under MIT license. |
| 10 | + |
| 11 | +## Becoming a Contributor |
| 12 | + |
| 13 | +Until the project has enough contributors a [BDFL](https://en.wikipedia.org/wiki/Benevolent_dictator_for_life) 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: |
| 14 | + |
| 15 | +1. An individual contributes actively via discussions (reporting bugs, giving feedback to existing or opening new issues) and / or pull requests |
| 16 | +2. The individual is either directly asked, invited or asks for contributor rights on the project |
| 17 | +3. The individual uses the contribution rights to sustain or increase the active contributions |
| 18 | + |
| 19 | +Every contributor has to sign the contributor's license agreement (CLA) to establish a legal trust between the project and its contributors. |
| 20 | + |
| 21 | +## Working on AngleSharp |
| 22 | + |
| 23 | +### Issue Discussion |
| 24 | + |
| 25 | +Discussion of issues should be placed transparently in the issue tracker here on GitHub. |
| 26 | + |
| 27 | +* [AngleSharp.Core](https://github.com/AngleSharp/AngleSharp/issues/) |
| 28 | +* [AngleSharp.Css](https://github.com/AngleSharp/AngleSharp.Css/issues/) |
| 29 | +* [AngleSharp.Io](https://github.com/AngleSharp/AngleSharp.Io/issues/) |
| 30 | +* [AngleSharp.Js](https://github.com/AngleSharp/AngleSharp.Js/issues/) |
| 31 | +* [AngleSharp.Xml](https://github.com/AngleSharp/AngleSharp.Xml/issues/) |
| 32 | + |
| 33 | +### Modifying the code |
| 34 | + |
| 35 | +AngleSharp and its libraries uses features from the latest versions of C# (e.g., C# 7). You will therefore need a C# compiler that is up for the job. |
| 36 | + |
| 37 | +1. Fork and clone the repo. |
| 38 | +2. First try to build the AngleSharp.Core libray and see if you get the tests running. |
| 39 | +3. You will be required to resolve some dependencies via NuGet. |
| 40 | + |
| 41 | +AngleSharp itself does not have dependencies, however, the tests are dependent on NUnit. |
| 42 | + |
| 43 | +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 may require NuGet 3.5, which looks for MSBuild pre-15, i.e., before Visual Studio 2017 on Windows systems. We aim to drop this requirement enitirely soon. |
| 44 | + |
| 45 | +### Code Conventions |
| 46 | + |
| 47 | +Most parts in the AngleSharp project are fairly straight forward. Among these are: |
| 48 | + |
| 49 | +- Always use statement blocks for control statements, e.g., in a for-loop, if-condition, ... |
| 50 | +- You may use a simple (throw) statement in case of enforcing contracts on argument |
| 51 | +- Be explicit about modifiers (some files follow an older convention of the code base, but we settled on the explicit style) |
| 52 | + |
| 53 | +There are a couple of rules, which are definitely not standard, but highly recommended for consistency and readability: |
| 54 | + |
| 55 | +- AngleSharp uses the RHS convention, where types are always put on the right hand side if possible, i.e., preferring `var` under all circumstances |
| 56 | +- A single empty line between two non-simple statements (e.g., for-loop and if-condition) should be inserted |
| 57 | +- Types are preferred to keywords (`String` instead of `string` or `Int32` instead of `int`) |
| 58 | +- `using` statements must be inside the namespace declaration |
| 59 | + |
| 60 | +### Development Workflow |
| 61 | + |
| 62 | +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. |
| 63 | +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. |
| 64 | +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`). |
| 65 | +3. Add failing tests for the change you want to make. Tests are crucial and should be taken from W3C (or other specification). |
| 66 | +4. Fix stuff. Always go from edge case to edge case. |
| 67 | +5. All tests should pass now. Also your new implementation should not break existing tests. |
| 68 | +6. Update the documentation to reflect any changes. (or document such changes in the original issue) |
| 69 | +7. Push to your fork or push your issue-specific branch to the main repository, then submit a pull request against `devel`. |
| 70 | + |
| 71 | +Just to illustrate the git workflow for AngleSharp a little bit more we've added the following graphs. |
| 72 | + |
| 73 | +Initially, AngleSharp starts at the `master` branch. This branch should contain the latest stable (or released) version. |
| 74 | + |
| 75 | +Here we now created a new branch called `devel`. This is the development branch. |
| 76 | + |
| 77 | +Now active work is supposed to be done. Therefore a new branch should be created. Let's create one: |
| 78 | + |
| 79 | +``` |
| 80 | +git checkout -b feature/#777 |
| 81 | +``` |
| 82 | + |
| 83 | +There may be many of these feature branches. Most of them are also pushed to the server for discussion or synchronization. |
| 84 | + |
| 85 | +``` |
| 86 | +git push -u origin feature/#777 |
| 87 | +``` |
| 88 | + |
| 89 | +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. |
| 90 | + |
| 91 | +``` |
| 92 | +git checkout devel |
| 93 | +git pull |
| 94 | +git pull origin feature/#777 |
| 95 | +git push |
| 96 | +``` |
| 97 | + |
| 98 | +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`. |
| 99 | + |
| 100 | +``` |
| 101 | +git checkout master |
| 102 | +git merge devel |
| 103 | +git tag v1.0 |
| 104 | +``` |
| 105 | + |
| 106 | +(The last part is automatically performed by our CI system.) |
| 107 | + |
| 108 | +### Versioning |
| 109 | + |
| 110 | +The rules of [semver](http://semver.org/) don't necessarily apply here, but we will try to stay quite close to them. |
| 111 | + |
| 112 | +Prior to version 1.0.0 we use the following scheme: |
| 113 | + |
| 114 | +1. MINOR versions for reaching a feature milestone potentially combined with dramatic API changes |
| 115 | +2. PATCH versions for refinements (e.g. performance improvements, bug fixes) |
| 116 | + |
| 117 | +After releasing version 1.0.0 the scheme changes to become: |
| 118 | + |
| 119 | +1. MAJOR versions at maintainers' discretion following significant changes to the codebase (e.g., API changes) |
| 120 | +2. MINOR versions for backwards-compatible enhancements (e.g., performance improvements) |
| 121 | +3. PATCH versions for backwards-compatible bug fixes (e.g., spec compliance bugs, support issues) |
| 122 | + |
| 123 | +#### Code style |
| 124 | + |
| 125 | +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. |
| 126 | + |
| 127 | +It is also important to keep a certain `async`-flow and to always use `ConfigureAwait(false)` in conjunction with an `await` expression. |
0 commit comments