search

thebrowsercompany / swift-webdriver

A Swift library for communicating with WebDriver (Appium/WinAppDriver) endpoints
BSD 3-Clause "New" or "Revised" License
100 stars 3 forks source link

feat: New contributing guidelines and usage outline #127

Closed Squidonomics closed 9 months ago

Squidonomics commented 10 months ago

This is the basic framework for contributing. I'd like to make more verbose docs on usage in the near future as well.

compnerd commented 10 months ago

Thanks @Squidonomics!

Squidonomics commented 10 months ago

Commit bee2dd8 has the format for usage I was thinking. Is there anything else more verbose you want to add before I write it out for all of them?

compnerd commented 10 months ago

I don't think that we should have example usage for each API. I think that the usage should be extremely high level (basically, how to add that to a SPM project). The API usage should be derived through doc comments, which should document the APIs as well as give any additional details such as samples.

Squidonomics commented 9 months ago

Something like a full getting started guide? I think that would be the best route. I'll push up what I'm thinking and you can see if that works.

Squidonomics commented 9 months ago

Can this be merged? @jeffdav

jeffdav commented 9 months ago

Can this be merged? @jeffdav

Of course! I approved the changes yesterday, I think. That's the green light! ✅