From 0d5430e679b4f2fb635a0955109da81d59ec9598 Mon Sep 17 00:00:00 2001 From: Rajiv Ranjan Singh Date: Tue, 6 Jul 2021 21:47:01 +0530 Subject: [PATCH 1/3] added contributing.md Signed-off-by: Rajiv Ranjan Singh --- CONTRIBUTING.md | 138 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 138 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..8e9440e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,138 @@ +# Guidelines for Contributing + +Thank you for your time on Wechaty OpenAPI. + +We have [gRPC](https://github.com/wechaty/grpc) for [Wechaty Puppet](https://github.com/wechaty/wechaty-puppet), and we want a RESTful API as well, so we built [OpenAPI Specification](https://www.openapis.org/) (OAS, former [Swagger](https://swagger.io/)) on top of gRPC, with the power of [gRPC OAS Gateway](https://github.com/grpc-ecosystem/grpc-gateway). + +## How to [contribute](https://github.com/wechaty/openapi/blob/master/CONTRIBUTING.md) + +- Write a blog about Wechaty OpenAPI. +- Create a tutorial for Wechaty OpenAPI. +- Help expand the [wiki](https://github.com/wechaty/openapi/wiki) +- Answer questions on the [issue](https://github.com/wechaty/openapi/issues) +- Review [pull requests](https://github.com/wechaty/openapi/pulls) +- Start [hacking on Wechaty](https://github.com/wechaty/openapi/blob/master/CONTRIBUTING.md) + +### Why contribute + +As an open-source product, Wechaty thrives on the contributions of community members. Whatever your skillset is, there is a lot you can do to help us make Wechaty better! +So start forking! + +### Not sure where to start? + +It's a myth that writing code is the only way to contribute to open source. Wechaty community is open to new ideas and there are so many different ways to make valuable contributions. We have some ideas of how you can get started! + +#### 1. Contribute Code + +- Check out GitHub issues with the tags `good first issue`, `pull request welcome`, or `help wanted` +- Write code examples for documentation +- Report a bug and work on resolving it +- Collaborate with others on building new features + +**Tips:** +If you want to add new features or change the API, please submit an issue first to make sure no one else is already working on the same thing and discuss the implementation and API details with maintainers and users by creating an issue. When everything is settled down, you can submit a pull request. + +Make sure to add tests for your features and bug fixes and update the documentation (see below) before submitting your code! + +#### 2. Contribute Support + +If you spot something new, open an issue using a [template](https://github.com/wechaty/openapi/issues/new/choose). We'll use the issue to have a conversation about the problem you want to fix. + +- Fix typos in documentation +- Translate documentation to your local language +- Write tutorials and blog posts, see more: https://github.com/wechaty/wechaty.js.org/tree/master/jekyll/_posts +- Answer questions on the Wechaty Developers Home or Github issues +- Organize Wechaty meetups or user groups in your area + +Contact rui@Wechaty.io to learn more + +#### 3. Ready to make a change? Fork the repo + +Fork using GitHub Desktop: + +- [Getting started with GitHub Desktop](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/getting-started-with-github-desktop) will guide you through setting up Desktop. +- Once the Desktop is set up, you can use it to [fork the repo](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/cloning-and-forking-repositories-from-github-desktop)! + +Fork using the command line: + +- [Fork the repo](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository) so that you can make your changes without affecting the original project until you're ready to merge them. + +Fork with [GitHub Codespaces](https://github.com/features/codespaces): + +- [Fork, edit, and preview](https://docs.github.com/en/free-pro-team@latest/github/developing-online-with-codespaces/creating-a-codespace) using [GitHub Codespaces](https://github.com/features/codespaces) without having to install and run the project locally. + +##### Open a pull request + +When you're done making changes and you'd like to propose them for review, use the pull request template to open your PR (pull request). + +##### Submit your PR & get it reviewed + +- Once you submit your PR, others from the Docs community will review it with you. The first thing you're going to want to do is a [self-review](#self-review). +- After that, we may have questions, check back on your PR to keep up with the conversation. +- Did you have an issue, like a merge conflict? Check out our [git tutorial](https://lab.github.com/githubtraining/managing-merge-conflicts) on how to resolve merge conflicts and other issues. + +##### Your PR is merged! + +Congratulations! The whole GitHub community thanks you. :sparkles: + +# Pull request template + +When you open a pull request, you must fill out the "Ready for review" template before we can review your PR. This template helps reviewers understand your changes and the purpose of your pull request. + +#### Suggested changes + +We may ask for changes to be made before a PR can be merged, either using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch. + +As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations). + +## Link to Wechaty + +Contribute by marketing: Add **Powered by Wechaty** Badge to your Project Homepage: + +[![Powered by Wechaty](https://img.shields.io/badge/Powered%20By-Wechaty-green.svg)](https://github.com/wechaty/openapi) + +### Markdown + +```markdown +[![Powered by Wechaty](https://img.shields.io/badge/Powered%20By-Wechaty-green.svg)](https://github.com/wechaty/openapi) +``` + +### Html + +```html + + Powered by Wechaty + +``` + +## Bug Report + +Contribute by feedback, make code robust. + +## Feature Request + +Contribute by make product suggestions. + +## Pull Request + +Please: + +1. submit an issue to describe the problem to get started +1. then send a pull request as you need(with unit test & pass linting) + +```bash +$ npm run lint +$ npm run test +``` + +1. and do not forget to reference the issue + +I built wechaty with pleasure because it can help others. help from you for wechaty will be very appreciated by the community. + +Cheers! + +Huan From e28baec7b440864116c5885b9ef5bc5623f402c4 Mon Sep 17 00:00:00 2001 From: Rajiv Ranjan Singh Date: Sun, 11 Jul 2021 23:41:41 +0530 Subject: [PATCH 2/3] added General Wechaty blog post guidelines link Signed-off-by: Rajiv Ranjan Singh --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8e9440e..8e52279 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,6 +13,8 @@ We have [gRPC](https://github.com/wechaty/grpc) for [Wechaty Puppet](https://git - Review [pull requests](https://github.com/wechaty/openapi/pulls) - Start [hacking on Wechaty](https://github.com/wechaty/openapi/blob/master/CONTRIBUTING.md) +**Note:** You can also refer to this for [General Wechaty blog post guidelines](https://github.com/wechaty/wechaty.js.org). + ### Why contribute As an open-source product, Wechaty thrives on the contributions of community members. Whatever your skillset is, there is a lot you can do to help us make Wechaty better! From ca16ceb6614a12f903d32d7f73f67ae96983ab64 Mon Sep 17 00:00:00 2001 From: Rajiv Singh Date: Fri, 10 Sep 2021 00:37:34 +0530 Subject: [PATCH 3/3] Update CONTRIBUTING.md --- CONTRIBUTING.md | 132 ++---------------------------------------------- 1 file changed, 3 insertions(+), 129 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8e52279..d8ca6df 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,138 +2,12 @@ Thank you for your time on Wechaty OpenAPI. -We have [gRPC](https://github.com/wechaty/grpc) for [Wechaty Puppet](https://github.com/wechaty/wechaty-puppet), and we want a RESTful API as well, so we built [OpenAPI Specification](https://www.openapis.org/) (OAS, former [Swagger](https://swagger.io/)) on top of gRPC, with the power of [gRPC OAS Gateway](https://github.com/grpc-ecosystem/grpc-gateway). +Check Wechaty contributing guidelines at [https://wechaty.js.org/docs/contributing/](https://wechaty.js.org/docs/contributing/). -## How to [contribute](https://github.com/wechaty/openapi/blob/master/CONTRIBUTING.md) - -- Write a blog about Wechaty OpenAPI. -- Create a tutorial for Wechaty OpenAPI. -- Help expand the [wiki](https://github.com/wechaty/openapi/wiki) -- Answer questions on the [issue](https://github.com/wechaty/openapi/issues) -- Review [pull requests](https://github.com/wechaty/openapi/pulls) -- Start [hacking on Wechaty](https://github.com/wechaty/openapi/blob/master/CONTRIBUTING.md) - -**Note:** You can also refer to this for [General Wechaty blog post guidelines](https://github.com/wechaty/wechaty.js.org). - -### Why contribute - -As an open-source product, Wechaty thrives on the contributions of community members. Whatever your skillset is, there is a lot you can do to help us make Wechaty better! +As an open-source product, Wechaty thrives on the contributions of community members. Whatever your skill set is, there is a lot you can do to help us make Wechaty better! So start forking! -### Not sure where to start? - -It's a myth that writing code is the only way to contribute to open source. Wechaty community is open to new ideas and there are so many different ways to make valuable contributions. We have some ideas of how you can get started! - -#### 1. Contribute Code - -- Check out GitHub issues with the tags `good first issue`, `pull request welcome`, or `help wanted` -- Write code examples for documentation -- Report a bug and work on resolving it -- Collaborate with others on building new features - -**Tips:** -If you want to add new features or change the API, please submit an issue first to make sure no one else is already working on the same thing and discuss the implementation and API details with maintainers and users by creating an issue. When everything is settled down, you can submit a pull request. - -Make sure to add tests for your features and bug fixes and update the documentation (see below) before submitting your code! - -#### 2. Contribute Support - -If you spot something new, open an issue using a [template](https://github.com/wechaty/openapi/issues/new/choose). We'll use the issue to have a conversation about the problem you want to fix. - -- Fix typos in documentation -- Translate documentation to your local language -- Write tutorials and blog posts, see more: https://github.com/wechaty/wechaty.js.org/tree/master/jekyll/_posts -- Answer questions on the Wechaty Developers Home or Github issues -- Organize Wechaty meetups or user groups in your area - -Contact rui@Wechaty.io to learn more - -#### 3. Ready to make a change? Fork the repo - -Fork using GitHub Desktop: - -- [Getting started with GitHub Desktop](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/getting-started-with-github-desktop) will guide you through setting up Desktop. -- Once the Desktop is set up, you can use it to [fork the repo](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/cloning-and-forking-repositories-from-github-desktop)! - -Fork using the command line: - -- [Fork the repo](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository) so that you can make your changes without affecting the original project until you're ready to merge them. - -Fork with [GitHub Codespaces](https://github.com/features/codespaces): - -- [Fork, edit, and preview](https://docs.github.com/en/free-pro-team@latest/github/developing-online-with-codespaces/creating-a-codespace) using [GitHub Codespaces](https://github.com/features/codespaces) without having to install and run the project locally. - -##### Open a pull request - -When you're done making changes and you'd like to propose them for review, use the pull request template to open your PR (pull request). - -##### Submit your PR & get it reviewed - -- Once you submit your PR, others from the Docs community will review it with you. The first thing you're going to want to do is a [self-review](#self-review). -- After that, we may have questions, check back on your PR to keep up with the conversation. -- Did you have an issue, like a merge conflict? Check out our [git tutorial](https://lab.github.com/githubtraining/managing-merge-conflicts) on how to resolve merge conflicts and other issues. - -##### Your PR is merged! - -Congratulations! The whole GitHub community thanks you. :sparkles: - -# Pull request template - -When you open a pull request, you must fill out the "Ready for review" template before we can review your PR. This template helps reviewers understand your changes and the purpose of your pull request. - -#### Suggested changes - -We may ask for changes to be made before a PR can be merged, either using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch. - -As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations). - -## Link to Wechaty - -Contribute by marketing: Add **Powered by Wechaty** Badge to your Project Homepage: - -[![Powered by Wechaty](https://img.shields.io/badge/Powered%20By-Wechaty-green.svg)](https://github.com/wechaty/openapi) - -### Markdown - -```markdown -[![Powered by Wechaty](https://img.shields.io/badge/Powered%20By-Wechaty-green.svg)](https://github.com/wechaty/openapi) -``` - -### Html - -```html - - Powered by Wechaty - -``` - -## Bug Report - -Contribute by feedback, make code robust. - -## Feature Request - -Contribute by make product suggestions. - -## Pull Request - -Please: - -1. submit an issue to describe the problem to get started -1. then send a pull request as you need(with unit test & pass linting) - -```bash -$ npm run lint -$ npm run test -``` - -1. and do not forget to reference the issue - -I built wechaty with pleasure because it can help others. help from you for wechaty will be very appreciated by the community. +We built wechaty with pleasure because it can help others. Help from you for wechaty will be very much appreciated by the community. Cheers!