This is an automated email from the ASF dual-hosted git repository. yifeizhang pushed a commit to branch develop in repository https://gitbox.apache.org/repos/asf/incubator-marvin.git
The following commit(s) were added to refs/heads/develop by this push: new 98b8cda Adding general contribution file :: Marvin-8 98b8cda is described below commit 98b8cdaf0a6f9cf4c739f9cd5f2ff74f04967d7a Author: yifeizhang <yifeizh...@apache.org> AuthorDate: Mon Jan 7 11:08:10 2019 -0200 Adding general contribution file :: Marvin-8 --- CONTRIBUTION.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md new file mode 100644 index 0000000..6927572 --- /dev/null +++ b/CONTRIBUTION.md @@ -0,0 +1,50 @@ +# Contributing + + When contributing to this repository, please discuss the change you wish to make via issue or + email list <d...@marvin.apache.org> with the members/administrators of this repository before. + + ## Components + + **Toolbox**: Set of CLI's, utilities, classes, specific libraries to each language, which supports the entire process of exploration, development, testing and delivery of an Engine. + + **Engine-executor**: Implementation of architectural abstraction around the Engine, such as parallelism, distribution, version control, APIs, availability. + + **Public-engines**: Engine examples. + + + ## Get started + + Clone the repository, [install][installguide] and run "marvin" to confirm the installation. + + Choose the issues that are labeled as "Good First Issue". + + ## Unit test + + The unit test is very important and of course it's required for this project, you can use "marvin test" command to run your tests. + + + ## New issue and pull request + + The community discusses and tracks known bugs and potential features in the [Github Issue Tracker][tbissue]. If you have a new idea or have identified a bug then you should raise it there to start public discussion + + This repository contains Issue Templates and Pull Request Templates, just follow the instructions described in templates. + + ## Where to ask for help + + 1. [Github Issue Tracker][tbissue]: for discussions about new features or established bugs + 2. [Gitter chat][gchat]: for real-time discussion + + ## Separate Code Repositories + + [Marvin-AI][marvinai] maintains all your code and documentation in multiple repositories on the Github. This includes the primary repository and several others repositories for different components. + + # Code of Conduct + + Our Code of Conduct is available at [Here][codepage] + + [codepage]: https://github.com/apache/incubator-marvin/blob/master/python-toolbox/CODE_OF_CONDUCT.md + [installguide]: https://github.com/apache/incubator-marvin/blob/master/python-toolbox/README.md + [tbissue]: https://issues.apache.org/jira/projects/MARVIN/issues?filter=allopenissues + [gchat]: https://gitter.im/marvin-ai + [marvinai]: https://github.com/apache/incubator-marvin +