adds standard project markdown files

CONTRIBUTING.md

@@ -0,0 +1,38 @@
+## How to contribute to metakb
+
+#### **Did you find a bug?**
+
+* **Do not open up a GitHub issue if the bug is a security vulnerability**.
+
+* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/cancervariants/metakb/issues).
+
+* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/cancervariants/metakb/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
+
+* If possible, use the relevant bug report templates to create the issue. Simply copy the content of the appropriate template into a .rb file, make the necessary changes to demonstrate the issue, and **paste the content into the issue description**:  
+
+
+#### **Did you write a patch that fixes a bug?**
+
+* Open a new GitHub pull request with the patch.
+
+* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
+
+* Before submitting, please read the codebase to know more about coding conventions and benchmarks.
+
+#### **Do you intend to add a new feature or change an existing one?**
+
+* Suggest your change in the [mailing list](todo) and start writing code.
+
+* Do not open an issue on GitHub until you have collected positive feedback about the change. GitHub issues are primarily intended for bug reports and fixes.
+
+#### **Do you have questions about the source code?**
+
+* Ask any question about how to use metakb in the [mailing list](todo).
+
+#### **Do you want to contribute to the metakb documentation?**
+
+* Ask any question about how to use metakb in the [mailing list](todo).
+
+Thanks! :heart:
+
+metakb Team

README.md

@@ -0,0 +1,112 @@
+# metakb
+
+The intent of the project is to leverage the collective knowledge of the disparate existing resources of the VICC to improve the comprehensiveness of clinical interpretation of genomic variation. An ongoing goal will be to provide and improve upon standards and guidelines by which other groups with clinical interpretation data may make it accessible and visible to the public. We have released a preprint discussing our initial harmonization effort and observed disparities in the structure and content of variant interpretations.
+
+## Getting Started
+
+> These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
+
+### Prerequisites
+
+What things you need to install the software and how to install them:
+
+* python3
+
+```
+python3 --version
+Python 3.7.1
+```
+
+### Installing
+
+Install requirements
+
+```
+pip3 install -r requirements.txt
+```
+
+Install requirements-dev
+
+```
+pip3 install -r requirements-dev.txt
+```
+
+
+> TODO End with an example of getting some data out of the system or using it for a little demo
+
+## Running the tests
+
+### Unit tests
+
+Explain how to run the automated tests for this system
+
+```
+python3 -m pytest
+```
+
+
+### Break down into end to end tests
+
+> TODO Explain what these tests test and why
+
+```
+TODO Give an example
+```
+
+### And coding style tests
+
+Code style is managed by [flake8](https://github.com/PyCQA/flake8) and checked prior to commit.
+
+```
+see .flake8
+
+```
+
+## Deployment
+
+> TODO Add additional notes about how to deploy this on a live system
+
+## Built With
+
+* [pre-commit](https://pre-commit.com) - Build chain
+* TODO ... add more
+
+## Contributing
+
+Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
+
+We use [pre-commit](https://pre-commit.com/#usage) to run conformance tests.
+
+This ensures:
+
+* Check code style
+* Check for added large files
+* Detect AWS Credentials
+* Detect Private Key
+
+Before first commit run:
+
+```
+pre-commit install
+```
+
+
+## Versioning
+
+We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/cancervariants/metakb/tags).
+
+## Authors
+
+* TODO
+
+See also the list of [contributors](https://github.com/cancervariants/metakb/contributors) who participated in this project.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
+
+## Acknowledgments
+
+* Hat tip to anyone whose code was used
+* Inspiration
+* etc