|
| 1 | +# Contributing to oneAPI-samples |
| 2 | + |
| 3 | +The `master` branch contains code samples that work with the latest released version of the [Intel® oneAPI Toolkits](https://www.intel.com/content/www/us/en/developer/tools/oneapi/toolkits.html). Do not commit change to the `master` branch. |
| 4 | + |
| 5 | +All contributions must go into the `development` branch where they will be reviewed before merging into the `master` branch. |
| 6 | + |
| 7 | +## Fork the Repository |
| 8 | + |
| 9 | +1. To fork the repository from the GitHub user interface, click the **Fork** icon then select **Create a new fork**. The fork will be created in few seconds. If you previously forked the repo, skip to the Step 5. |
| 10 | + |
| 11 | +2. Select an **Owner** for the forked repository. |
| 12 | + |
| 13 | +3. Deselect the **Copy the master branch only** check box. (It should be unchecked before proceeding to the next step.) |
| 14 | + |
| 15 | +4. Click the **Create fork** button. |
| 16 | + |
| 17 | +5. If you have an existing fork but do not have a `development` branch, create a `development` branch by selecting the oneapi-src/oneAPI-samples `development` branch in the dropdown as the branch source. |
| 18 | + |
| 19 | +6. Once your fork has been created, click the **Settings** icon and find the **Default Branch** section. |
| 20 | + |
| 21 | +7. Click the **Switch to another branch** graphic. |
| 22 | + |
| 23 | +8. From the dropdown, change the default branch to `development`. Click the **Update** button. |
| 24 | + |
| 25 | +9. To create a branch in your fork, make sure the `development` branch is selected from the dropdown, and enter the name of your branch in the text field. |
| 26 | + |
| 27 | +## Clone Your Fork |
| 28 | + |
| 29 | +Clone the repo and checkout the branch that you just created by entering a command similar to the following: |
| 30 | + |
| 31 | +``` |
| 32 | +git clone -b <your branch name> https://github.com/<your GitHub username>/<your repo name>.git |
| 33 | +``` |
| 34 | + |
| 35 | +Once you are ready to commit your changes to your repo, enter commands similar to the following: |
| 36 | + |
| 37 | +``` |
| 38 | +git add . |
| 39 | +git commit -s -m "<insert commit reason here>" |
| 40 | +git push origin |
| 41 | +``` |
| 42 | + |
| 43 | +## Submit Pull Requests |
| 44 | + |
| 45 | +When submitting a pull request, keep the following guidelines in mind: |
| 46 | + |
| 47 | +- Make sure that your pull request has a clear purpose; it should be as simple as possible. This approach enables quicker PR reviews. |
| 48 | + |
| 49 | +- Explain anything non-obvious from the code in comments, commit messages, or the PR description, as needed. |
| 50 | + |
| 51 | +- Check the number of files being updated. Ensure that your pull request includes only the files you expected to be changed. (If there are additional files you did not expect included in the commit, troubleshoot before submitting the PR.) |
| 52 | + |
| 53 | +## Log a Bug or Request a Feature |
| 54 | + |
| 55 | +We use [GitHub Issues](https://github.com/oneapi-src/oneAPI-samples/issues) to track sample development issues, bugs, and feature requests. |
| 56 | + |
| 57 | +When reporting a bug, provide the following information when possible: |
| 58 | + |
| 59 | +- Steps to reproduce the bug. |
| 60 | +- Whether you found or reproduced the bug using the latest sample in the `master` branch and the latest Intel® oneAPI Toolkits. |
| 61 | +- Version numbers or other information about the CPU/GPU/FPGA/device, platform, operating system or distribution you used to find the bug. |
| 62 | + |
| 63 | +For usage, installation, or other requests for help, go to the [Intel® oneAPI Forums](https://software.intel.com/en-us/forums/intel-oneapi-forums) for more information. |
| 64 | + |
| 65 | +## License |
| 66 | + |
| 67 | +Code samples in this repository are licensed under the terms outlined in [License.txt](https://github.com/oneapi-src/oneAPI-samples/blob/master/License.txt). By contributing to the project, you agree to the license and copyright terms therein and release your contribution under these terms. |
0 commit comments