Skip to content

Commit 3e4f126

Browse files
authored
Merge pull request #7 from FlaUI/contributing-guidelines
Added contribution guidelines
2 parents a47240a + 97fc5b3 commit 3e4f126

1 file changed

Lines changed: 32 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# How to contribute
2+
3+
## Building
4+
5+
Use `dotnet build` to build.
6+
7+
## Testing
8+
9+
Use `dotnet test` to run tests. At the moment the tests are end-to-end UI tests that use [Selenium.WebDriver](https://www.nuget.org/packages/Selenium.WebDriver) to operate a test application, running FlaUI.WebDriver.exe in the background, so they should be run on Windows.
10+
11+
Add UI tests for every feature added and every bug fixed, and feel free to improve existing test coverage.
12+
13+
## Submitting changes
14+
15+
Please send a [GitHub Pull Request](https://github.com/FlaUI/FlaUI.WebDriver/pulls) with a clear list of what you've done (read more about [pull requests](http://help.github.com/pull-requests/)). Please follow our coding conventions (below) and make sure all of your commits are atomic (one feature per commit).
16+
17+
Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:
18+
19+
$ git commit -m "A brief summary of the commit
20+
>
21+
> A paragraph describing what changed and its impact."
22+
23+
## Coding conventions
24+
25+
Follow the [.NET Runtime Coding Style](https://github.com/dotnet/runtime/blob/main/docs/coding-guidelines/coding-style.md).
26+
27+
## Releasing
28+
29+
To release, simply create a tag and push it, which will trigger the release automatically:
30+
31+
git tag -a v0.1.0-alpha -m "Your tag message"
32+
git push origin v0.1.0-alpha

0 commit comments

Comments
 (0)