Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

basic contributing guide on contributing and opening a PR #1773

Merged
merged 1 commit into from
May 22, 2024
Merged

basic contributing guide on contributing and opening a PR #1773

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 24 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,29 @@
# Contributing to MLServer

Opening a PR
------------
* Fork the repository from `SeldonIO` into local Github account.
* create a branch from the master of the forked repository.<br> `git checkout -b <branch>`.
<br> branches can be named as `bug|feat|doc|`_`<desc>`_`<optional params>`
* make changes, and raise a PR from local repository `<branch>` to main repository `master`.
* make sure that your branch is always uptodate (you may use rebase to resolve conflicts) with **SeldonIO/MLServer** `master` branch. <br>
```bash
git remote add upstream https://github.com/SeldonIO/MLServer.git
git fetch upstream
git checkout <your_branch_name>
git rebase upstream/master
```

Installation for Contributing
sakoush marked this conversation as resolved.
Show resolved Hide resolved
------------
- git clone the forked repository: <br>`git clone <your-repo>/MLServer <your-folder>`
- setup `mlserver`: ```pip install .```
- run examples in debugging mode and verify execution taking one to breakpoints in one's development branch

Raising a PR
------------
- Choose a default PR template/templates available underneath `/docs/PULL_REQUEST_TEMPLATE/` as a `template` query param.

_Before opening a pull request_ consider:

- Is the change important and ready enough to ask the community to spend time reviewing?
Expand Down
26 changes: 26 additions & 0 deletions docs/PULL_REQUEST_TEMPLATE/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Pull Request

## Description
<!-- Provide a brief description of the purpose of this pull request -->

## Changes Made
<!-- Describe the changes introduced by this pull request -->

## Related Issues
<!-- Mention any related issues or tickets that are being addressed by this pull request -->

## Screenshots (if applicable)
<!-- Add screenshots or images to visually represent the changes, if applicable -->

## Checklist
<!-- Make sure to check the items below before submitting your pull request -->

- [ ] Code follows the project's style guidelines
- [ ] All tests related to the changes pass successfully
- [ ] Documentation is updated (if necessary)
- [ ] Code is reviewed by at least one other team member
- [ ] Any breaking changes are communicated and documented

## Additional Notes
<!-- Add any additional notes or context that may be helpful for reviewers -->