You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@opendal.apache.org by "suyanhanx (via GitHub)" <gi...@apache.org> on 2023/12/12 14:28:03 UTC
[PR] docs: update the RFC doc [incubator-opendal]
suyanhanx opened a new pull request, #3748:
URL: https://github.com/apache/incubator-opendal/pull/3748
(no comment)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@opendal.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: update the RFC doc [incubator-opendal]
Posted by "Xuanwo (via GitHub)" <gi...@apache.org>.
Xuanwo merged PR #3748:
URL: https://github.com/apache/incubator-opendal/pull/3748
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@opendal.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: update the RFC doc [incubator-opendal]
Posted by "Xuanwo (via GitHub)" <gi...@apache.org>.
Xuanwo commented on code in PR #3748:
URL: https://github.com/apache/incubator-opendal/pull/3748#discussion_r1424761046
##########
core/src/docs/rfcs/mod.rs:
##########
@@ -15,166 +15,204 @@
// specific language governing permissions and limitations
// under the License.
-//! RFCs power OpenDAL's development.
-//!
-//! To add new features and big refactors:
-//!
-//! - Start a new RFCs with the template [`rfc_0000_example`].
-//! - Submit PR and assign the RFC number with the PR number.
-//! - Request reviews from OpenDAL maintainers.
-//! - Create a tracking issue and update links in RFC after approval.
-//!
-//! Some useful tips:
-//!
-//! - Start a pre-propose in [discussion](https://github.com/apache/incubator-opendal/discussions/categories/ideas) to communicate quickly.
-//! - The proposer of RFC may not be the same person as the implementor. Try to include enough information in RFC itself.
+#![doc = include_str!("README.md")]
+/// RFC example
#[doc = include_str!("0000_example.md")]
pub mod rfc_0000_example {}
+/// Object native API
Review Comment:
This will add extra work to add new RFCs, how about removing them?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@opendal.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: update the RFC doc [incubator-opendal]
Posted by "suyanhanx (via GitHub)" <gi...@apache.org>.
suyanhanx commented on code in PR #3748:
URL: https://github.com/apache/incubator-opendal/pull/3748#discussion_r1424810694
##########
core/src/docs/rfcs/mod.rs:
##########
@@ -15,166 +15,204 @@
// specific language governing permissions and limitations
// under the License.
-//! RFCs power OpenDAL's development.
-//!
-//! To add new features and big refactors:
-//!
-//! - Start a new RFCs with the template [`rfc_0000_example`].
-//! - Submit PR and assign the RFC number with the PR number.
-//! - Request reviews from OpenDAL maintainers.
-//! - Create a tracking issue and update links in RFC after approval.
-//!
-//! Some useful tips:
-//!
-//! - Start a pre-propose in [discussion](https://github.com/apache/incubator-opendal/discussions/categories/ideas) to communicate quickly.
-//! - The proposer of RFC may not be the same person as the implementor. Try to include enough information in RFC itself.
+#![doc = include_str!("README.md")]
+/// RFC example
#[doc = include_str!("0000_example.md")]
pub mod rfc_0000_example {}
+/// Object native API
Review Comment:
This is also to enhance the aesthetics of our RFC list simply.
I am open to doing the additional work, even if it involves just one line.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@opendal.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org