Skip to content

Latest commit

 

History

History
52 lines (31 loc) · 2.05 KB

CONTRIBUTING.md

File metadata and controls

52 lines (31 loc) · 2.05 KB
Raw

How to Contribute

If you are interested in contributing to Puppeteer Sharp, Thank you!

Coding is not for lonely wolves. Welcome to the pack!

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. If you don’t know what to do, ASK! We have many many things to implement :)

Getting setup

  1. Clone this repository using your favorite tool

  2. Create a self signed certificate:

The test server requires a self-signed certificate at this location: .\lib\PuppeteerSharp.TestServer\testCert.cer

You can run this PowerShell script on Windows

New-SelfSignedCertificate -Subject "localhost" -FriendlyName "Puppeteer" -CertStoreLocation "cert:\CurrentUser\My"

Get-ChildItem -Path cert:\CurrentUSer\my | where { $_.friendlyname -eq "Puppeteer" } | Export-Certificate -FilePath C:\projects\puppeteer-sharp\lib\PuppeteerSharp.TestServer\testCert.cer

On MacOS, you can create an “SSL Server” certificate using the Keychain Access app and then export it to .\lib\PuppeteerSharp.TestServer\testCert.cer

Code reviews

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on pull requests.

Code Style

Though this list will change over time, these are the things to consider now:

  • We are team spaces.
  • Every public API should have an XML documentation.
  • Try to follow the current style.
  • Don’t reinvent the wheel.

Commit Messages

Don’t worry about commit messages or about how many commits your PR has. Your PR will be squashed, so the commit message will be set at that time.

Writing Tests

  • Every feature should be accompanied by a test.
  • Every public api event/method should be accompanied by a test.