You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@weex.apache.org by ha...@apache.org on 2018/03/09 13:46:12 UTC
[1/2] incubator-weex-site git commit: Updating document for
Contributing to Weex
Repository: incubator-weex-site
Updated Branches:
refs/heads/master c941b0d76 -> 3770be6f8
Updating document for Contributing to Weex
Changes are done to the document for simplifying the language and
also providing more details to some of the sections.
Project: http://git-wip-us.apache.org/repos/asf/incubator-weex-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-weex-site/commit/8b180e70
Tree: http://git-wip-us.apache.org/repos/asf/incubator-weex-site/tree/8b180e70
Diff: http://git-wip-us.apache.org/repos/asf/incubator-weex-site/diff/8b180e70
Branch: refs/heads/master
Commit: 8b180e7032ac6d49e6edf51aa7d353517c191a09
Parents: c941b0d
Author: Varun Sobti <va...@paytm.com>
Authored: Fri Mar 9 12:56:17 2018 +0530
Committer: Varun Sobti <va...@paytm.com>
Committed: Fri Mar 9 12:56:17 2018 +0530
----------------------------------------------------------------------
source/contributing.md | 36 +++++++++++++++++++++++-------------
1 file changed, 23 insertions(+), 13 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-weex-site/blob/8b180e70/source/contributing.md
----------------------------------------------------------------------
diff --git a/source/contributing.md b/source/contributing.md
index 3b47f30..b5bdecd 100644
--- a/source/contributing.md
+++ b/source/contributing.md
@@ -7,42 +7,52 @@ version: 2.1
# How to Contribute
-Apache Weex is an open source project which is under active development, developers can participate and contribute to the Apache Weex community in a variety of ways. Contributing doesn't just mean contributing code, reporting bugs, answering questions, joining in discussions and contributing documentation are also welcome.
-
-## Report Bugs
+Apache Weex is an open source project that is under active development and we're continuously working out to simplify contributing to Weex ecosystem. Developers can participate and contribute to the Apache Weex community by reporting bugs, contributing code, answering questions, joining in discussions and contributing to documentation.
+## Bugs
You can use Weex directly through [Get Started](./guide/index.html) tutorial. If you encounter any unexpected phenomena during your use, feel free to let us know by filing a bug report.
+##### Find Known Issues
+We are using JIRA for tracking all the issues and updating whenever when have an internal fix in progress. Before filing a new task, try to confirm if it is already listed or if there is a fix in progress.
+
+##### Report New Issues
Open a [JIRA Issue](https://issues.apache.org/jira/projects/WEEX) , click on the top red "Create" button (you may need to [create a JIRA account](https://issues.apache.org/jira/secure/Signup!default.jspa) if you haven't registered). [Bug Report Guidelines](../bug-report-guidelines.html) document provides some of the most useful information about writing a good bug report. The better your bug report is, the faster we can reproduce and fix it!
+## Contribute Code
+
+Apache Weex is an open source project and both, core team members and external contributors, send pull requests which go through the same review process. If you have already decided to start writing code in Weex, Congratulations! You’re up and running.
+
+You can contribute code by either fixing an existing bug or developing new features. In either case, we always encourage to create a JIRA ticket and ensure we are in agreement on your proposal.
+
+To help you get started, we've created a document with more details about development process. Please read **[Getting Started with Development Process](../development-process.html)**.
+
## Ask or Answer Questions
For basic use problems and help, we suggest you ask questions on [stackoverflow.com](http://stackoverflow.com/) and mark them with **weex** tag.
-You can also view all [Weex related issues](http://stackoverflow.com/questions/tagged/weex), answer some of the questions if you can, this will also help you get familiar with basic concepts and common misunderstandings about Weex, which can be useful when contributing documentation or code.
+You can also view all [Weex related issues](http://stackoverflow.com/questions/tagged/weex) and answer some of the questions if you can. This will also help you get familiar with basic concepts and common misunderstandings about Weex, which can be useful when contributing documentation or code.
## Join in Discussions
In Weex community, most discussions happen on the mailing list.
-Dev mailing list `dev@weex.incubator.apache.org` is the place where Weex developers exchange ideas and discuss new features, new releases and the development process.
+Dev mailing list "dev@weex.incubator.apache.org" is the place where Weex developers exchange ideas and discuss new features, new releases and the development process.
-Contributors and developers should subscribe to this list and follow it in order to keep up to date on what’s happening in Weex.[(subscribe)](mailto:dev-subscribe@weex.incubator.apache.org?subject=%28send%20this%20email%20to%20subscribe%29) [(unsubscribe)](mailto:dev-unsubscribe@weex.incubator.apache.org?subject=%28send%20this%20email%20to%20unsubscribe%29) [(archives)](http://mail-archives.apache.org/mod_mbox/incubator-weex-dev/)
+Contributors and developers should subscribe to this list and follow it in order to keep up to date on what’s happening in Weex. [(subscribe)](mailto:dev-subscribe@weex.incubator.apache.org?subject=%28send%20this%20email%20to%20subscribe%29) [(unsubscribe)](mailto:dev-unsubscribe@weex.incubator.apache.org?subject=%28send%20this%20email%20to%20unsubscribe%29) [(archives)](http://mail-archives.apache.org/mod_mbox/incubator-weex-dev/)
## Contribute Documentation
-Documentation with good quality is a great help to developers. If there is a powerful API that is not easy to use, it becomes useless. So, we welcome any contributions to help Weex's documents become precise and easy to read.
+Documentation with good quality is a great help to developers. If there is a powerful API that is not easy to use, it becomes useless. So, we welcome any contributions to help Weex's documents become precise and easy to read.
To make changes to the document, you can edit the corresponding Markdown file at the [weex-site repository](https://github.com/apache/incubator-weex-site) and create a pull request.
-## Contribute Code
+## How to Become a Committer
-If you have already decided to start writing code in Weex and contributing your fix and features to the project, congratulations! You’re up and running.
+Committers are core members of the community who can access the project's repository and modify its code, documentation and web sites, as well as accept the contributions of other developers.
-**For details on starting to work on a code contribution, please read [Development Process](../development-process.html).**
+There's no exact criteria for becoming a committer, we are looking for contributors who are actively involved in community contributions and who have continued interest in Weex. If you are interested in becoming a Weex committer, contact any existing committer and we will help you go through the invitation process.
-## How to Become a Committer
-Committers are core members of the community who can access the project's repository and modify its code, documentation and web sites, as well as accept the contributions of other developers.
+## License
+By contributing to Weex, you agree that your contributions will be licensed under its Apache License, Version 2.0.
-There's no exact criteria for becoming a committer, we are looking for contributors who are actively involved in community contributions and who have continued interest in Weex. If you are interested in becoming a Weex committer, contact any existing committer and we will help you go through the invitation process.
\ No newline at end of file
[2/2] incubator-weex-site git commit: Updating link text to match
page title
Posted by ha...@apache.org.
Updating link text to match page title
The text of Getting Started page link was incorrect and we have updated
it for consistency.
Project: http://git-wip-us.apache.org/repos/asf/incubator-weex-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-weex-site/commit/3770be6f
Tree: http://git-wip-us.apache.org/repos/asf/incubator-weex-site/tree/3770be6f
Diff: http://git-wip-us.apache.org/repos/asf/incubator-weex-site/diff/3770be6f
Branch: refs/heads/master
Commit: 3770be6f860261b78603d3197498d76f929329c3
Parents: 8b180e7
Author: Varun Sobti <va...@paytm.com>
Authored: Fri Mar 9 17:27:33 2018 +0530
Committer: Varun Sobti <va...@paytm.com>
Committed: Fri Mar 9 17:27:33 2018 +0530
----------------------------------------------------------------------
source/contributing.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-weex-site/blob/3770be6f/source/contributing.md
----------------------------------------------------------------------
diff --git a/source/contributing.md b/source/contributing.md
index b5bdecd..0df300d 100644
--- a/source/contributing.md
+++ b/source/contributing.md
@@ -10,7 +10,7 @@ version: 2.1
Apache Weex is an open source project that is under active development and we're continuously working out to simplify contributing to Weex ecosystem. Developers can participate and contribute to the Apache Weex community by reporting bugs, contributing code, answering questions, joining in discussions and contributing to documentation.
## Bugs
-You can use Weex directly through [Get Started](./guide/index.html) tutorial. If you encounter any unexpected phenomena during your use, feel free to let us know by filing a bug report.
+You can use Weex directly through [Getting Started](./guide/index.html) tutorial. If you encounter any unexpected phenomena during your use, feel free to let us know by filing a bug report.
##### Find Known Issues
We are using JIRA for tracking all the issues and updating whenever when have an internal fix in progress. Before filing a new task, try to confirm if it is already listed or if there is a fix in progress.