Cole Ramos
0a52e6f19d
* Update contributing guide for new default branch Signed-off-by: coleramos425 <colramos@amd.com> * Add develop target to related workflows Signed-off-by: coleramos425 <colramos@amd.com> * Auto sync develop and staging Signed-off-by: coleramos425 <colramos@amd.com> * Run sync every night at 12AM Signed-off-by: coleramos425 <colramos@amd.com> * Rename sync workflow Signed-off-by: coleramos425 <colramos@amd.com> * Update maintainers guide Signed-off-by: coleramos425 <colramos@amd.com> * Update readme Signed-off-by: coleramos425 <colramos@amd.com> * Auto accept PRs for daily branch sync Signed-off-by: coleramos425 <colramos@amd.com> * Direct merge. No PR for merge required Signed-off-by: coleramos425 <colramos@amd.com> --------- Signed-off-by: coleramos425 <colramos@amd.com>
2.8 KiB
How to fork from us
To keep our development fast and conflict free, we recommend you to fork our repository and start your work from our develop branch in your private repository.
Afterwards, git clone your repository to your local machine. But that is not it! To keep track of the original develop repository, add it as another remote.
git remote add mainline https://github.com/ROCm/rocprofiler-compute.git
git checkout develop
As always in git, start a new branch with
git checkout -b topic-<yourFeatureName>
and apply your changes there. For more help reference GitHub's 'About Forking' page.
How to contribute to ROCm Compute Profiler
Did you find a bug?
-
Ensure the bug was not already reported by searching on GitHub under Issues.
-
If you're unable to find an open issue addressing the problem, open a new one.
Did you write a patch that fixes a bug?
-
Open a new GitHub pull request with the patch.
-
Ensure the PR description clearly describes the problem and solution. If there is an existing GitHub issue open describing this bug, please include it in the description so we can close it.
-
Ensure the PR is based on the
developbranch of the ROCm Compute Profiler GitHub repository.
Tip
To ensure you meet all formatting requirements before publishing, we recommend you utilize our included pre-commit hooks. For more information on how to use pre-commit hooks please see the section below.
Using pre-commit hooks
Our project supports optional pre-commit hooks which developers can leverage to verify formatting before publishing their code. Once enabled, any commits you propose to the repository will be automatically checked for formatting. Initial setup is as follows:
python3 -m pip install pre-commit
cd rocprofiler-compute
pre-commit install
Now, when you commit code to the repository you should see something like this:
Please see the pre-commit documentation for additional information.
Coding guidelines
Below are some repository specific guidelines which are followed througout the repository. Any future contributions should adhere to these guidelines:
- Use pathlib library functions instead of os.path for manipulating file paths