8000 Update CONTRIBUTING policy by mmjb · Pull Request #51 · github/CodeSearchNet · GitHub
[go: up one dir, main page]

Skip to content
This repository was archived by the owner on Apr 11, 2023. It is now read-only.

Update CONTRIBUTING policy #51

Merged
merged 2 commits into from
Sep 30, 2019
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Update CONTRIBUTING policy
  • Loading branch information
mmjb authored Sep 30, 2019
commit f91c8113ba239c3edae031443a5d1618d7c5cc75
13 changes: 8 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,14 @@ Please note that this project is released with a [Contributor Code of Conduct][c

## Scope

We anticipate that the community will design custom architectures and use frameworks other than Tensorflow. Furthermore, we anticipate that other datasets beyond the ones provided in this project might be useful. It is not our intention to integrate the best models and datasets into this repository as a superset of all available ideas. Rather, we intend to provide baseline approaches and a central place of reference with links to related repositories from the community. Therefore, we are accepting pull requests for the following items:

- Bug fixes
- Updates to documentation, including links to your project(s) where improvements to the baseline have been made
- Minor improvements to the code (generally excluding changes regarding improvements to the model or preprocessing to this repository - file an issue to discuss ideas)
We want to use this repository to distribute the best data pre-processing and loading pipeline for the CodeSearchNet dataset.
As anicipate other data scientists and researchers to design custom architectures and use frameworks other than Tensorflow, we do not want to update the models in this repository beyond the simple baselines we originally released.
Therefore, we are accepting pull requests for the following items:

- Improvements of the data pre-processing pipeline (e.g. better cleaning heuristics, new supported languages, etc.)
- Documentation updates that help others use the dataset
- Documentation updates with links to your project(s) where improvements to the baseline have been made
- Bug fixes for bugs in the baseline models (i.e., not better hyperparameter settings)

Please open an issue if you are unsure regarding the best course of action.

Expand Down
0