Skip to content

Commit 4f4aeba

Browse files
authored
Add Contributing.md
1 parent 569e728 commit 4f4aeba

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed

CONTRIBUTING.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# How to Contribute
2+
3+
If you are interested in contributing to Puppeteer Sharp, Thank you!
4+
5+
Coding is not for lonely wolves. Welcome to the pack!
6+
7+
The project has a clear roadmap we want to follow. If you want to contribute, ask before submitting a PR. We will analyze if it’s the right moment to implement that feature or not.
8+
If you don’t know what to do, ASK! We have many many things to implement :)
9+
10+
## Getting setup
11+
12+
1. Clone this repository using your favorite tool
13+
14+
2. Create a self signed certificate:
15+
16+
The test server requires a self-signed certificate at this location: `.\lib\PuppeteerSharp.TestServer\testCert.cer`
17+
18+
You can run this PowerShell script on Windows
19+
20+
```
21+
New-SelfSignedCertificate -Subject "puppeteer" -FriendlyName "Puppeteer" -CertStoreLocation "cert:\LocalMachine\My"
22+
Get-ChildItem -Path cert:\LocalMachine\my | where { $_.subject -eq "CN=puppeteer" } | Export-Certificate -FilePath .\lib\PuppeteerSharp.TestServer\testCert.cer
23+
```
24+
25+
On MacOS, you can create an “SSL Client” certificate using the Keychain Access app and then export it to `.\lib\PuppeteerSharp.TestServer\testCert.cer`
26+
27+
28+
## Code reviews
29+
30+
All submissions, including submissions by project members, require review. We
31+
use GitHub pull requests for this purpose. Consult
32+
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
33+
information on pull requests.
34+
35+
## Code Style
36+
37+
Though this list will change over time, these are the things to consider now:
38+
* [We are team spaces](https://www.youtube.com/watch?v=SsoOG6ZeyUI).
39+
* Try to follow the current style.
40+
* Don’t reinvent the wheel.
41+
42+
## Commit Messages
43+
44+
Don’t worry about commit messages or about how many commits your PR has. [Your PR will be squashed](https://help.github.com/articles/about-pull-request-merges/#squash-and-merge-your-pull-request-commits), so the commit message will be set at that time.
45+
46+
## Writing Tests
47+
48+
Every feature should be accompanied by a test.
49+
50+
Every public api event/method should be accompanied by a test.

0 commit comments

Comments
 (0)