|
| 1 | +# Contributing |
| 2 | + |
| 3 | +👍🎉 First off, thank you for taking the time to contribute! 🎉👍 |
| 4 | + |
| 5 | +The following is a set of guidelines for contributing. These are just guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. |
| 6 | + |
| 7 | +## What Should I Know Before I Get Started? |
| 8 | + |
| 9 | + |
| 10 | +### How Do I Start Contributing? |
| 11 | + |
| 12 | +The below workflow is designed to help you begin your first contribution journey. It will guide you through creating and picking up issues, working through them, having your work reviewed, and then merging. |
| 13 | + |
| 14 | +Help on open source projects is always welcome and there is always something that can be improved. For example, documentation (like the text you are reading now) can always use improvement, code can always be clarified, variables or functions can always be renamed or commented on, and there is always a need for more test coverage. If you see something that you think should be fixed, take ownership! Here is how you get started: |
| 15 | + |
| 16 | +## How Can I Contribute? |
| 17 | + |
| 18 | +When contributing, it's useful to start by looking at [issues](https://github.com/foundation-model-stack/fms-guardrails-orchestrator/issues). After picking up an issue, writing code, or updating a document, make a pull request and your work will be reviewed and merged. If you're adding a new feature or find a bug, it's best to [write an issue](https://github.com/foundation-model-stack/fms-guardrails-orchestrator/issues/new) first to discuss it with maintainers. |
| 19 | + |
| 20 | +To contribute to this repo, you'll use the Fork and Pull model common in many open source repositories. For details on this process, check out [The GitHub Workflow |
| 21 | +Guide](https://github.com/kubernetes/community/blob/master/contributors/guide/github-workflow.md) |
| 22 | +from Kubernetes. |
| 23 | + |
| 24 | +When your contribution is ready, you can create a pull request. Pull requests are often referred to as "PR". In general, we follow the standard [GitHub pull request](https://help.github.com/en/articles/about-pull-requests) process. Follow the template to provide details about your pull request to the maintainers. |
| 25 | + |
| 26 | +Before sending pull requests, make sure your changes pass formatting, linting and unit tests. |
| 27 | + |
| 28 | +#### Code Review |
| 29 | + |
| 30 | +Once you've [created a pull request](#how-can-i-contribute), maintainers will review your code and may make suggestions to fix before merging. It will be easier for your pull request to receive reviews if you consider the criteria the reviewers follow while working. Remember to: |
| 31 | + |
| 32 | +- Run tests locally and ensure they pass |
| 33 | +- Follow the project coding conventions |
| 34 | +- Write detailed commit messages |
| 35 | +- Break large changes into a logical series of smaller patches, which are easy to understand individually and combine to solve a broader issue |
| 36 | + |
| 37 | +### Reporting Bugs |
| 38 | + |
| 39 | +This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report ✏️, reproduce the behavior 💻, and find related reports 🔎. |
| 40 | + |
| 41 | +#### How Do I Submit A (Good) Bug Report? |
| 42 | + |
| 43 | +Bugs are tracked as [GitHub issues using the Bug Report template](https://github.com/foundation-model-stack/fms-guardrails-orchestrator/issues/new?assignees=&labels=&template=bug_report.md&title=). Create an issue on that and provide the information suggested in the bug report issue template. |
| 44 | + |
| 45 | +### Suggesting Enhancements |
| 46 | + |
| 47 | +This section guides you through submitting an enhancement suggestion, including completely new features, tools, and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion ✏️ and find related suggestions 🔎 |
| 48 | + |
| 49 | +#### How Do I Submit A (Good) Improvement Item? |
| 50 | + |
| 51 | +Improvements to existing functionality are tracked as [GitHub issues using the User Story template](https://github.com/foundation-model-stack/fms-guardrails-orchestrator/issues/new?assignees=&labels=&template=user_story.md&title=). Create an issue and provide the information suggested in the feature requests or user story issue template. |
| 52 | + |
| 53 | + |
| 54 | +## Your First Code Contribution |
| 55 | + |
| 56 | +Unsure where to begin contributing? You can start by looking through these issues: |
| 57 | + |
| 58 | +- Issues with the [`good first issue` label](https://github.com/foundation-model-stack/fms-guardrails-orchestrator/labels/good%20first%20issue) - these should only require a few lines of code and are good targets if you're just starting contributing. |
| 59 | +- Issues with the [`help wanted` label](https://github.com/foundation-model-stack/fms-guardrails-orchestrator/labels/help%20wanted) - these range from simple to more complex, but are generally things we want but can't get to in a short time frame. |
| 60 | + |
| 61 | +<!-- ## Releasing (Maintainers only) |
| 62 | +
|
| 63 | +The responsibility for releasing new versions of the libraries falls to the maintainers. Releases will follow standard [semantic versioning](https://semver.org/) and be hosted on [pypi](https://pypi.org/project/jtd-to-proto/). --> |
0 commit comments