This document has been rewritten to clarify for partners (and our own team) how to incorporate the arch board into creating new libraries and adding features into existing libraries. It now details the number and types of meetings that should happen for new work and big feature adds. It also now describes a lighter process for smaller changes and gives guidance for previewing API changes before going GA.
Instructions on how to create API reviews has been updated based on current tooling.
* Updating logging guidance
Logging guidance in the Java design guidelines had fallen behind the general guidelines, and was inconsistent with the actual API being offered (which was based on the general guidance). This is a copy / paste of the general guidelines into the java guidelines, replacing the old guidance (particularly around level naming (trace -> verbose)).
* moved and renamed various go doc sections
* fixes based on feedback
* move LRO info around
* fixed up paged types, other clean-up
* update LRO section
* merge implementation into design
* added missing directory structure info
refactored response types
* remove links to golang_implementation
* updates to response types
* add examples and positive guidence to config.e
* add build config examples to config sample.
* remove confusing configuration guidence point.
config guidence now reflects some converstaions we've had in the 1-10-2020
meeting.
* Initial commit with C++ guidelines extracted from the C guidelines.
* Update namespace rules to match the general guidelines, add "details" namespace. Noted to *not* use typedef for structs/classes in C++ code. Update supported platforms / compilers with RHEL and SLES. Note that we don't know about deployment.
* Further address C isms in these guidelines.
* Changes made during 2019-12-12 meeting.
* Add chrono examples.
Remove global examples.
Remove "less preferred".
Remove notes to review things that have already been reviewed.
Add note that common exception types need to be provided by the core library.
* Add default-initialization example.
* Add a couple of todos to investigate next meeting.
* Add todo about RHEL and SLES.
* Apply some outcomes of the 2019-12-19 meeting.
* Add more outcomes.
* Apply remaining outcomes.
* Apply documentation section fixes from Charlie.
* Merge changes from the C guidelines into the CPP guidelines.
* Fix links
* JS: Guidelines for tags to use
* JS: Guidelines for tags to use
* tags and hotfixes
* Update text on preview packages
Co-Authored-By: Jeff Fisher <xirzec@xirzec.com>
* Update docs/policies/releases.md
Co-Authored-By: Jeff Fisher <xirzec@xirzec.com>
* hot fix -> hotfix
Co-Authored-By: Jeff Fisher <xirzec@xirzec.com>
git will keep shas around for if they exist in a branch or if
a tag points at them so it isn't necessary to always merge hotfix
branches back into master to preserve the commit. The release tag
will be enough to preserve the commit.
Update some language around hotfixes based on recent feedback on
the JS and Python teams.
* versioning changes guidelines for python after GA
* updated dev build daily number to 3 digit padding
* Added note about hotfix branch
* review comments incorporated
* Update spec:
* remove httpLogDetailLevel and add new API
* Interfaces should not start with 'I'
* Maven artifact IDs must follow similar naming structure and include group in name
* Finalising the text for service versioning. Based largely on the .Net spec text.
* Minor tweaks based on review feedback
* Update design guidelines for Go
Added sections for logging, distributed tracing and versioning.
* feedback from review, add section about prerelease modules
* Added requirements for etag handling
* Updated based on feedback from board
* Updates after review by @annelo-msft
* More comments from @annelo-msft
* Address JR concerns
* Anne's updates
* Updated spec to detail module requirements and answer some questions about naming patterns
* Update spec based on feedback from Srikanta
* Adding guidance on expandable enums, as well as allowed and disallowed types
* Updated spec text to clarify the need to disambiguate the getId() methods
* Add guideline about using a common argument validator
Relates to Azure/azure-sdk-for-net#7547 and should be merged only after PR Azure/azure-sdk-for-net#7569 is merged.
* Resolve PR feedback
* Move implementation details to separate page
This is similar to what other languages do. Added the jekyll-relative-links plugin, which is documented to be supported by GitHub already anyway.
* * Updating spec to latest discussed guidelines:
* Reactor and Netty should not longer be part of the public API
* Return type for sync collections is no longer Stream - it is either PagedIterable or IterableStream (depending on ability to move by page).
* Changing API design for all methods to no longer be prefixed with get / set / is / etc, except in the case of service methods (i.e. those performing network operations).
* Fixes for typos, formatting, and bad links.
* Moving the 'not' into the 'MUSTNOT' so it formats correctly.
* Update spec to clarify that PagedFlux should always be used, and Flux never used.
Update spec to clarify method naming conventions.
* Revert naming for client methods that vend subclients back to the previous API - to prefix with 'get'
* update documentation to describe release strategies known to date
* review feedback part 1
* additional updates
* spelling
* further clarification
* finish updating version specifiers
* clarify how dependency versions move up
* add breaking change exception language
* Removing old data as preparation for new Jekyll site
* Jekyll site implementation
* Updated links in README
* Corrected link for TypeScript
* Replacement for PR #526
* Integration of PR #538
* Rename of the sidebar titles, per bterlson
* External links open in same tab
* Added common redirects for the guidelines
* Added redirects for migration from the azuresdkspec site
* Added general guidelines redirect
* Added Review Process
* Replacement for PR #541
* Moved README-EXAMPLE to repo
* Fixing links in .NET guidelines
* (#312) Made the guidelines and policy release versioning agree
Krzysztof Cwalina
Scott Kurtzeborn
Adrian Hall
Jon Gallant
Scott Schaab
Chidozie Ononiwu
Heath Stewart
Wes Haggard
Jonathan Giles
Mitch Denny
Charlie Barto
Joel Hendrix
Brian Terlson
Billy O'Neal
Azure SDK Bot
Ramya Rao
Lucian Bargaoanu
praveenkuttappan
Jeff Fisher
Pavel Krymets
Marsh Macy
Daniel Jurek
Bruce Johnston
Noel
Rikki Gibson