Skip to content

Commit aad4a5a

Browse files
authored
basic contributing guide on contributing and opening a PR (#1773)
1 parent c57a6ce commit aad4a5a

File tree

2 files changed

+50
-0
lines changed

2 files changed

+50
-0
lines changed

CONTRIBUTING.md

+24
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,29 @@
11
# Contributing to MLServer
22

3+
Opening a PR
4+
------------
5+
* Fork the repository from `SeldonIO` into local Github account.
6+
* create a branch from the master of the forked repository.<br> `git checkout -b <branch>`.
7+
<br> branches can be named as `bug|feat|doc|`_`<desc>`_`<optional params>`
8+
* make changes, and raise a PR from local repository `<branch>` to main repository `master`.
9+
* make sure that your branch is always uptodate (you may use rebase to resolve conflicts) with **SeldonIO/MLServer** `master` branch. <br>
10+
```bash
11+
git remote add upstream https://github.com/SeldonIO/MLServer.git
12+
git fetch upstream
13+
git checkout <your_branch_name>
14+
git rebase upstream/master
15+
```
16+
17+
Installation for Contributing
18+
------------
19+
- git clone the forked repository: <br>`git clone <your-repo>/MLServer <your-folder>`
20+
- setup `mlserver`: ```pip install .```
21+
- run examples in debugging mode and verify execution taking one to breakpoints in one's development branch
22+
23+
Raising a PR
24+
------------
25+
- Choose a default PR template/templates available underneath `/docs/PULL_REQUEST_TEMPLATE/` as a `template` query param.
26+
327
_Before opening a pull request_ consider:
428

529
- Is the change important and ready enough to ask the community to spend time reviewing?
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Pull Request
2+
3+
## Description
4+
<!-- Provide a brief description of the purpose of this pull request -->
5+
6+
## Changes Made
7+
<!-- Describe the changes introduced by this pull request -->
8+
9+
## Related Issues
10+
<!-- Mention any related issues or tickets that are being addressed by this pull request -->
11+
12+
## Screenshots (if applicable)
13+
<!-- Add screenshots or images to visually represent the changes, if applicable -->
14+
15+
## Checklist
16+
<!-- Make sure to check the items below before submitting your pull request -->
17+
18+
- [ ] Code follows the project's style guidelines
19+
- [ ] All tests related to the changes pass successfully
20+
- [ ] Documentation is updated (if necessary)
21+
- [ ] Code is reviewed by at least one other team member
22+
- [ ] Any breaking changes are communicated and documented
23+
24+
## Additional Notes
25+
<!-- Add any additional notes or context that may be helpful for reviewers -->
26+

0 commit comments

Comments
 (0)