diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d6a99206393..dd1557048fc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,14 +2,15 @@ Thanks for your interest in the opendatahub-operator project! You can contribute to this project in various ways: filing bug reports, proposing features, submitting pull requests (PRs), and improving documentation. -Before you begin, please take a look at our contribution guidelines below to ensure that your contribuutions are aligned with the project's goals. +Before you begin, please take a look at our contribution guidelines below to ensure that your contributions are aligned with the project's goals. ## Reporting Issues + Issues are tracked using [Jira](https://issues.redhat.com/secure/RapidBoard.jspa?rapidView=18680#). If you encounter a bug or have suggestions for enhancements, please follow the steps below: 1. **Check for Existing Issues:** Before creating a new issue, search the Jira project to see if a similar issue already exists. -2. **Create a Jira Ticket:** If the issue doesn’t exist, create a new ticket in Jira. - - **For Feature Requests:** Set the issue type to be `Initative` +2. **Create a Jira Ticket:** If the issue doesn’t exist, create a new ticket in Jira. + - **For Feature Requests:** Set the issue type to be `Initiative` - **For Bugs:** Set the issue type to `Bug` - **For all other code changes:** Use the issue type `Story` @@ -18,9 +19,9 @@ Issues are tracked using [Jira](https://issues.redhat.com/secure/RapidBoard.jspa ### Workflow 1. **Fork the Repository:** Create your own fork of the repository to work on your changes. -2. **Create a Branch:** Create your own branch to include changes for the feature or a bug fix off of `incubation` branch. +2. **Create a Branch:** Create your own branch to include changes for the feature or a bug fix off of the `incubation` branch. 3. **Work on Your Changes:** Commit often, and ensure your code adheres to these [Code Style Guidelines](#code-style-guidelines) and passes all the [quality gates](#quality-gates) for the operator. -4. **Testing:** Make sure your code passes all the tests, including any new tests you've added. +4. **Testing:** Make sure your code passes all the tests, including any new tests you've added. And that your changes do not decrease the test coverage as shown on report. Every new feature should come with unit tests that cover that new part of the code. ### Open a Pull Request: @@ -36,8 +37,8 @@ To ensure the contributed code adheres to the project goals, we have set up some 1. [linters](https://github.com/opendatahub-io/opendatahub-operator/blob/incubation/.github/workflows/linter.yaml): Ensure the check for linters is successful. If it fails, run `make lint` to resolve errors 2. [api-docs](https://github.com/opendatahub-io/opendatahub-operator/blob/incubation/.github/workflows/check-file-updates.yaml): Ensure the api-docs are updated when making changes to operator apis. If it fails, run `make generate manifests api-docs` to resolve errors -3. [unit-tests](https://github.com/opendatahub-io/opendatahub-operator/blob/incubation/.github/workflows/unit-tests.yaml): Ensure unit tests pass. Run `make unit-tests` -4. [e2e-tests](https://prow.ci.openshift.org/job-history/gs/test-platform-results/pr-logs/directory/pull-ci-opendatahub-io-opendatahub-operator-incubation-opendatahub-operator-e2e): Ensure CI job for [e2e tests](https://github.com/opendatahub-io/opendatahub-operator/tree/incubation/tests/e2e) pass. Refer run e2e locally to debug. CI test logs can also be found under `Artifacts` directory under Job details. +3. [unit-tests](https://github.com/opendatahub-io/opendatahub-operator/blob/incubation/.github/workflows/unit-tests.yaml): Ensure unit tests pass. Run `make unit-tests` +4. [e2e-tests](https://prow.ci.openshift.org/job-history/gs/test-platform-results/pr-logs/directory/pull-ci-opendatahub-io-opendatahub-operator-incubation-opendatahub-operator-e2e): Ensure CI job for [e2e tests](https://github.com/opendatahub-io/opendatahub-operator/tree/incubation/tests/e2e) pass. Refer to run e2e locally to debug. CI test logs can also be found under the `Artifacts` directory under Job details. ### Code Style Guidelines @@ -52,7 +53,7 @@ To ensure the contributed code adheres to the project goals, we have set up some ### Commit Messages We follow the conventional commits format for writing commit messages. A good commit message should include: -1. **Type:** `fix`, `feat`, `docs`, `chore`, etc. **Note:** All commits except `chore` require an associated jira issue. Please add link to your jira issue. +1. **Type:** `fix`, `feat`, `docs`, `chore`, etc. **Note:** All commits except `chore` require an associated jira issue. Please add a link to your jira issue. 2. **Scope:** A short description of the area affected. 3. **Summary:** A brief explanation of what the commit does. @@ -78,4 +79,4 @@ Follow the same [PR Guide](#pull-requests) for creating and reviewing downstream For general questions, feel free to open a discussion in our repository or communicate via: - **Slack:** All issues related to ODH platform can be discussed in **#forum-openshift-ai-operator** channel. -- **Jira Comments**: Feel free to discuss issues directly on Jira tickets. \ No newline at end of file +- **Jira Comments**: Feel free to discuss issues directly on Jira tickets.