Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update process per SSWG 9/16 meeting #50

Merged
merged 2 commits into from
Oct 14, 2020

Conversation

tomerd
Copy link
Contributor

@tomerd tomerd commented Oct 6, 2020

motivation: the SSWG reviewed the incubation process on 9/16 and suggested changes

changes:

Sandbox

  • Single developer okay
  • License: MIT and BSD also okay

Incubating

  • Min 2 developers
  • Flow of commits or issues addressed -> since mature projects issues addressed could be better indications

Graduated

  • Require a stable API -> No major API changes planned in the foreseeable future
  • Define how new major API should be introduced, and what support is expected for older major versions (1 back? More?)
  • Add link to Swift code style guide
  • Encourage the use of formatting tooling + add link to such tools
  • Remove Unsafe / make it an example
  • CI setup for every platform decanted as supported
    • At least one Linux distro
  • Remove redundant swift versions support line item

motivation: the SSWG reviewed the incubation process on 9/16 and suggested changes

changes:

Sandbox
-------
* Single developer okay
* License: MIT and BSD also okay

Incubating
----------
* Min 2 developers
* Flow of commits or issues addressed -> since mature projects issues addressed could be better indications

Graduated
---------
* Require a stable API -> No major API changes planned in the foreseeable future
* Define how new major API should be introduced, and what support is expected for older major versions (1 back? More?)
* Add link to Swift code style guide
* Encourage the use of formatting tooling + add link to such tools
* Remove Unsafe / make it an example
* CI setup for every platform decanted as supported
    * At least one Linux distro
* Remove redundant swift versions support line item
@tomerd
Copy link
Contributor Author

tomerd commented Oct 6, 2020

draft proposal for your review: @weissi @tanner0101 @toddvarland @loganwright @kmahar @tachyonics @PeterAdams-A

@tomerd tomerd changed the title update process per SSWG 9/16 meeting DRAFT: update process per SSWG 9/16 meeting Oct 6, 2020
Copy link
Contributor

@ktoso ktoso left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bystander opinion: Changes look good to me :)

Copy link
Contributor

@PeterAdams-A PeterAdams-A left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved with comments.

* CI setup for two latest versions of Swift.org recommnded Linux distributions
* CI setup for two latest Swift.org recommended versions of Swift
* CI setup for at least one of Swift.org recommended Linux distributions
* CI setup for each platform supported by the library or tool
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Swift-NIO runs on anything from Apple Watch up - it doesn't have CI for all the device platforms.

As the swift server working group are we only interested in potential server platforms eg macOS, linux, windows?

* Packages should be non-blocking (w/ async API) unless not possible (blocking C libs, etc)
* There should be as little (preferably no) wrapping of NIO as possible. Exposing NIO types directly will go a long way for making packages compatible.
* Blocking code should be wrapped in NonBlockingIOPool (like Vapor's SQLite package)
* Uses force unwraps and force tries only as preconditions, ie. conditions that the programmer regards as impossible or programmer error. All force tries/unwraps should come with a comment stating the reasons
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use rather than Uses? Similarly Do rather than Does below? Feels like the subject of this section changes as you read through it to me although I wouldn't claim expertise at written text.

Copy link
Contributor

@weissi weissi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@weissi weissi marked this pull request as ready for review October 14, 2020 16:30
Copy link
Member

@tanner0101 tanner0101 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

* Licensing
* Apache 2
* Apache 2, MIT or BSD (Apache 2 recommended)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

missing serial comma

* Apache 2, MIT or BSD (Apache 2 recommended)
* Conventions and Style
* Adopt [Swift API Design Guidelines](https://swift.org/documentation/api-design-guidelines/)
* Follow [SSWG Technical Best Practices](#technical-best-practices)) when applicable.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

extra )

@weissi weissi changed the title DRAFT: update process per SSWG 9/16 meeting update process per SSWG 9/16 meeting Oct 14, 2020
process/incubation.md Outdated Show resolved Hide resolved
process/incubation.md Outdated Show resolved Hide resolved
process/incubation.md Outdated Show resolved Hide resolved
process/incubation.md Outdated Show resolved Hide resolved
process/incubation.md Outdated Show resolved Hide resolved
Co-authored-by: Kaitlin Mahar <kaitlinmahar@gmail.com>
@tomerd tomerd merged commit dd61091 into swift-server:main Oct 14, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants