Skip to content

Commit a7bed55

Browse files
author
Guillem Duran
committed
Apply suggestions from PR#2
Signed-off-by: Guillem Duran <[email protected]>
1 parent 60cb3eb commit a7bed55

8 files changed

+22
-26
lines changed

license.md renamed to LICENSE.md

File renamed without changes.
File renamed without changes.

README.md

+11-7
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,23 @@
11
# MLonCode Core Library
2-
[![Build Status](https://travis-ci.org/src-d/ml-core.svg)](https://travis-ci.org/src-d/ml-core)
3-
[![codecov](https://codecov.io/github/src-d/ml-core/coverage.svg)](https://codecov.io/gh/src-d/ml-core)
4-
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
2+
[![Travis build status](https://travis-ci.com/src-d/ml-core.svg)](https://travis-ci.com/src-d/ml-core)
3+
[![Code coverage](https://codecov.io/github/src-d/ml-core/coverage.svg)](https://codecov.io/github/src-d/ml-core)
4+
[![Read the Docs](https://img.shields.io/readthedocs/ml-core.svg)](https://readthedocs.org/projects/ml-core/)
5+
[![Docker build status](https://img.shields.io/docker/build/srcd/ml-corer.svg)](https://hub.docker.com/r/srcd/ml-core)
6+
[![PyPi package status](https://img.shields.io/pypi/v/srcd-ml-core.svg)](https://pypi.python.org/pypi/srcd-ml-core)
7+
![stability: alpha](https://svg-badge.appspot.com/badge/stability/alpha?color=f47142)
8+
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
59

610
This library is the foundation for [MLonCode](https://github.com/src-d/awesome-machine-learning-on-source-code) research and development.
7-
It contains commonly used algorithms and tools to process the code-related data, such as [Babelfish's UASTs](https://doc.bblf.sh/), plain code text and other.
11+
It contains commonly used algorithms and tools to process the code-related data, such as [Babelfish's UASTs](docs.sourced.tech/babelfish), plain code text and other.
812

913
## Contributions
1014

11-
...are welcome! See [CONTRIBUTING](contributing.md) and [CODE\_OF\_CONDUCT.md](code_of_conduct.md).
15+
...are welcome! See [CONTRIBUTING.md](docs/CONTRIBUTING.md) and [CODE\_OF\_CONDUCT.md](docs/CODE_OF_CONDUCT.md).
1216

1317
## License
1418

15-
[Apache 2.0](license.md)
19+
[Apache 2.0](LICENSE.md)
1620

1721
## Glossary
1822

19-
See [here](GLOSSARY.md).
23+
See [here](docs/GLOSSARY.md).

SUMMARY.md

-16
This file was deleted.
File renamed without changes.

contributing.md renamed to docs/CONTRIBUTING.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# CONTRIBUTING
22

3-
ml-core project is [Apache licensed](license.md) and accepts contributions via GitHub pull
3+
ml-core project is [Apache licensed](LICENSE.md) and accepts contributions via GitHub pull
44
requests. This document outlines some of the conventions on development workflow, commit message formatting, contact points, and other resources to make it easier to get your contribution accepted.
55

66
## Certificate of Origin
@@ -15,7 +15,7 @@ This can be done easily using the [`-s`](https://github.com/git/git/blob/b2c150d
1515

1616
The official support channels, for both users and contributors, are:
1717

18-
* GitHub [issues](https://github.com/src-d/ml/issues)\*
18+
* GitHub [issues](https://github.com/src-d/ml-core/issues)\*
1919
* Slack: \#machine-learning room in the [source{d} Slack](https://join.slack.com/t/sourced-community/shared_invite/enQtMjc4Njk5MzEyNzM2LTFjNzY4NjEwZGEwMzRiNTM4MzRlMzQ4MmIzZjkwZmZlM2NjODUxZmJjNDI1OTcxNDAyMmZlNmFjODZlNTg0YWM)
2020

2121
\*Before opening a new issue or submitting a new pull request, it's helpful to search the project - it's likely that another user has already reported the issue you're facing, or it's a known issue that we're already aware of.
@@ -29,7 +29,7 @@ Pull Requests \(PRs\) are the main and exclusive way to contribute to the offici
2929
* The code is formatted according to [![PEP8](https://img.shields.io/badge/code%20style-pep8-orange.svg)](https://www.python.org/dev/peps/pep-0008/).
3030
* If the PR is a bug fix, it has to include a new unit test that fails before the patch is merged.
3131
* If the PR is a new feature, it has to come with a suite of unit tests, that tests the new functionality.
32-
* In any case, all the PRs have to pass the personal evaluation of at least one of the [maintainers](maintainers.md).
32+
* In any case, all the PRs have to pass the personal evaluation of at least one of the [maintainers](MAINTAINERS.md).
3333

3434
### Format of the commit message
3535

File renamed without changes.

docs/SUMMARY.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Table of contents
2+
3+
* [README](README.md)
4+
* [LICENSE](LICENSE.md)
5+
* [MAINTAINERS](MAINTAINERS.md)
6+
* [CODE\_OF\_CONDUCT](docs/CODE_OF_CONDUCT.md)
7+
* [CONTRIBUTING](docs/CONTRIBUTING.md)
8+

0 commit comments

Comments
 (0)