The awesome-machine-learning-on-source-code project is CC-BY-SA 4.0 licensed and accepts contributions via GitHub pull requests and tweets to @sourcedtech. This document outlines some of the conventions on submission workflow, commit message formatting, contact points, and other resources to make it easier to get your contribution accepted.
The official support channels, for both users and contributors, are:
- GitHub pull requests*
- Slack: #machine-learning room in the source{d} Slack
*Before opening a new pull request, it's helpful to search the current list and the existing pulls - it's possible that another user has already reported your item.
By contributing to this project, you agree to the Developer Certificate of Origin (DCO). This document was created by the Linux Kernel community and is a simple statement that you, as a contributor, have the legal right to make the contribution.
In order to show your agreement with the DCO you should include at the end of the commit message,
the following line: Signed-off-by: John Doe <[email protected]>, using your real name.
This can be done easily using the -s flag on the git commit.
Pull Requests (PRs) are the main way to contribute. In order for a PR to be accepted, it needs to pass this list of requirements:
- It should follow the link template*.
- The addition should be correctly classified as a paper, a blog post, a talk, a software or a dataset.
- It shouldn't be a duplicate.
- All the PRs have to pass the personal evaluation of at least one of the maintainers.
*Link template:
* [Title](URL) - Description.
The description should not start with "A" or "The". For papers, it should include the authors.
The commit summary must start with a verb (Add …, Deprecate …) and end without a dot.
A listed repository should be deprecated if:
- Repository's owner explicitly says that "this library is not maintained".
- Not committed for long time (2~3 years).
To mark a repository as deprecated, put [DEPRECATED] before the title and move it at the bottom of the list.