Weex community respects all kinds of contributing, including but not limited to code, documentation, mailing list.
To make an open and friendly community, Weex community adopt Contributor Covenant as the code of conduct.
If it didn‘t happen on a mailing list, it didn’t happen.
In Weex community, feature requests, discussions and decisions happen on the mailing list, which is open to the whole world. Ref our website to see more.
Weex Community Github Issue to report and track bugs 。The more information provided in a Github issue, the sooner it get solved.
- Avoid duplicated: Always search on Github before you fire a new one.
- Always run with the latest version before you fire a bug
- Only report one bug in one Github Issue.
Please use the Bug Report template when firing a bug. All the information needed to solve a bug is listed in the Bug report template , please fill it out as much as you can. The more information provided in a Github issue, the sooner it get solved.
Report bug with fact and expected behavior, not complaint or emotional words.
Compared to the amount of issues, Weex community may not response to your issues in time, please be patient.
If your Github issue doesn't get any response over a week, you can ask developers through weex mailing list.
Most of the development process is described in confluence, which services the contributors of Weex and is transparent to all users.
In Weex community, Documentation is as important as code, and Weex community respects all the contribution of documentation or code.
Weex adopts Apache License 2.0 as its open source license. Make sure your contribution obeys the requirement of Apache License 2.0.
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 contributions to help documentation of Weex become precise and easy to read.
You can contribute to a document through the following ways:
The development of Weex is on master branch, you should write your code based on master branch.
Weex adopts Apache License 2.0 as its open source license. Make sure your potential contribution obeys the requirement of Apache License 2.0.
Clone the forked repository and create a new branch from
master to push your commits to.
Develop your feature or bug fix in your new branch. Make sure your code meets the style guidelines.
Add the License below to the top of any new file(s) you've added.
/* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. */
Commit all the changes to your branch.
If you are writing Java or C++ with Android Studio, License will be added to the head of the file automatically.
*operator goes with the variable name (e.g. Type *variable;)
#pragma marksto categorize methods into functional groupings and protocol implementations
Open a pull request against the
master branch of
apache/incubator-weex. Make sure following guidelines are considered when creating a pull request.
COMPONENTis one of the mentioned PR categories (android, iOS, JsFm, web, test, etc..).
Summaryshould be a brief description of your change within one sentence.
There will be a static check program when you submit a PR,and the following rules will be checked:
Documentationand it's corresponding http links. if not, you will receive a warning message.
Demoand it's corresponding http links. if not, you will receive a warning message.
Reviewing PR may take a great deal of time, please be patient. If your PR doesn't get response over 96 hours, you might send an email to mailing list to ask the progress.
You can find committers, PPMCs and governance model of Weex from confluence.