This is an automated email from the ASF dual-hosted git repository. glauesppen pushed a commit to branch feature/update-docs in repository https://gitbox.apache.org/repos/asf/incubator-wayang.git
commit 461cea26f2b9e0e54dd75e6995ba54b4aa762a01 Author: Glaucia Esppenchutz <[email protected]> AuthorDate: Mon Jun 19 14:18:13 2023 +0100 adding more contributing info --- CONTRIBUTING.md | 18 ++++++++++++++++-- README.md | 2 +- guides/wayang-examples.md | 5 +++++ 3 files changed, 22 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index df8b204a..8e223d90 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,9 +17,23 @@ --> -## Contributing +# Contributing As a contributor, you can help shape the future of the project by providing feedback, joining our mailing lists, reporting bugs, requesting features, and participating in discussions. As you become more involved, you can also help with development by providing patches for bug fixes or features and helping to improve our documentation. If you show sustained commitment to the project, you may be invited to become a committer. This brings with it the privilege of write access to the project repository and resources. -To learn more about how to get involved with the Apache Wayang project, please visit our “Get Involved” [page](https://wayang.apache.org/community/) and read the [Apache code of conduct](https://www.apache.org/foundation/policies/conduct.html). We look forward to your contributions! +To learn more about how to get involved with the Apache Wayang project, please visit our “Get Involved” [page](https://wayang.apache.org/community/) and read the [Apache code of conduct](https://www.apache.org/foundation/policies/conduct.html). We look forward to your contributions! + + +## Contributing Workflow +*under progress* + +## Wayang Branch Strategy +All new code is under the `main` branch. Please, use this branch when forking this repo. + +Before opening a Pull Request(PR), make sure the builds and tests are passing on your local environment. + +### Release +The eligible code will be included in a release branch and properly tagged. + + diff --git a/README.md b/README.md index 23f34dea..fe1dc84a 100644 --- a/README.md +++ b/README.md @@ -182,7 +182,7 @@ You can see examples on how to start using Wayang [here](guides/wayang-examples. * [Maven](https://maven.apache.org/) ## Contributing -For more information about how to contribute with Apache Wayang, see the [CONTRIBUTING.md](CONTRIBUTING.md) guide. +Before submitting a PR, please take a look on how to contribute with Apache Wayang contributing guidelines [here](CONTRIBUTING.md). ## Authors The list of [contributors](https://github.com/apache/incubator-wayang/graphs/contributors). diff --git a/guides/wayang-examples.md b/guides/wayang-examples.md index e67602f6..2efd7b44 100644 --- a/guides/wayang-examples.md +++ b/guides/wayang-examples.md @@ -17,6 +17,11 @@ --> This page contains examples to be executed using Wayang. +- [WordCount](#wordcount) + * [Java scala-like API](#java-scala-like-api) + * [Scala API](#scala-api) +- [k-means](#k-means) + * [Scala API](#scala-api-1) ## WordCount
