Skip to content

Commit 336f002

Browse files
Update README.md
1 parent f8b8a9d commit 336f002

1 file changed

Lines changed: 26 additions & 13 deletions

File tree

README.md

Lines changed: 26 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -74,19 +74,32 @@ pip install -r requirements.txt
7474
python3 app.py
7575
```
7676

77-
78-
## Contributing
79-
80-
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
81-
82-
1. Fork the Project
83-
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
84-
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
85-
4. Push to the Branch (`git push origin feature/AmazingFeature`)
86-
5. Open a Pull Request to the development branch
87-
88-
89-
77+
# Contributing
78+
79+
When contributing to this repository, please first discuss the change you wish to make via issue,
80+
email, or any other method with the owners of this repository before making a change.
81+
82+
83+
## Pull Request Process
84+
1. Ensure any install or build dependencies are removed before the end of the layer when doing a
85+
build.
86+
2. Update the README.md with details of changes to the interface, this includes new environment
87+
variables, exposed ports, useful file locations and container parameters.
88+
3. Only send your pull requests to the development branch where once we reach a stable point
89+
it will be merged with the master branch
90+
4. Associate each Pull Request with the required issue number
91+
92+
## Branch Policy
93+
* development: If you are making a contribution make sure to send your Pull Request to this branch . All
94+
developments goes in this branch.
95+
* master: After significant features/bug-fixes are accumulated in development branch we merge it with the master branch.
96+
97+
## Contribution Practices
98+
* Write clear and meaningful commit messages.
99+
* If you report a bug please provide steps to reproduce the bug.
100+
* In case of changing the backend routes please submit an updated routes documentation for the same.
101+
* If there is an UI related change it would be great if you could attach a screenshot
102+
with the resultant changes so it is easier to review for the maintainers
90103

91104
## License
92105

0 commit comments

Comments
 (0)