Update CONTRIBUTING.md

This commit is contained in:
Ludovico Magnocavallo 2021-09-30 12:37:40 +02:00 committed by GitHub
parent 071cf03545
commit f314c3ba94
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 6 deletions

View File

@ -1,11 +1,15 @@
# Contributing
We welcome any contributions or feature requests you would like to submit!
We welcome any contributions on bugs, or feature requests you would like to submit!
Fork the Project
* Create your Feature Branch (git checkout -b feature/AmazingFeature)
* Commit your Changes (git commit -m 'Add some AmazingFeature')
* Push to the Branch (git push origin feature/AmazingFeature)
The basic process is pretty simple:
* Fork the Project
* Create your Feature Branch<br>`git checkout -b feature/AmazingFeature`
* Commit your Changes<br>`git commit -m 'Add some AmazingFeature`
* Push to the Branch<br>`git push origin feature/AmazingFeature`
* Make sure tests pass!<br>pytest # in the root folder
* Make sure any changes to variables and outputs are reflected in READMEs<br>`./tools/tfdoc.py [changed folder]`
* Open a Pull Request
When implementing your new feature, please follow Fabric [core design principles](./MANIFESTO.md#core-design-principles).
When implementing your new feature, please follow our [core design principles](./MANIFESTO.md#core-design-principles).