-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
47 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
# Contributor's Guide | ||
|
||
Thank you for considering contributing to this project. This document outlines the process and guidelines for contributing. | ||
|
||
## Table of Contents | ||
- [Getting Started](#getting-started) | ||
- [Pull Requests](#pull-requests) | ||
- [Code Style](#code-style) | ||
- [Reporting Issues](#reporting-issues) | ||
- [Community and Support](#community-and-support) | ||
|
||
## Getting Started | ||
|
||
1. Fork the repository on GitHub. | ||
2. Clone the forked repository to your local machine. | ||
3. Navigate to the project directory and install the required dependencies. | ||
4. Create a new branch for your feature, bugfix, or improvement. | ||
|
||
## Pull Requests | ||
|
||
1. Make sure all tests pass and there are no linting errors in your code. | ||
2. Commit your changes in a meaningful manner. | ||
3. Push your branch to your fork. | ||
4. Open a pull request from your branch to the project's `master` or `main` branch. | ||
5. Describe the changes you've made in detail and reference any issues it addresses. | ||
|
||
**Note:** Before submitting a pull request, ensure that your changes merge cleanly with the `master` or `main` branch. | ||
|
||
## Code Style | ||
|
||
- Follow the style of the existing code. | ||
- Include comments to explain the purpose and reasoning behind significant pieces of code. | ||
- Write descriptive commit messages. | ||
|
||
## Reporting Issues | ||
|
||
- Use the issue tracker to report bugs or suggest features. | ||
- Before submitting a new issue, please search to see if someone has already reported the same issue. | ||
- Include as much information as possible in your report: steps to reproduce the bug, error messages, your operating system/version, etc. | ||
|
||
## Community and Support | ||
|
||
If you have any questions, join our [discussions](https://github.com/orgs/HIP-infrastructure/discussions). | ||
|
||
--- | ||
|
||
Thank you again for considering contributing to our project! |