Skip to content

Commit

Permalink
Added CONTRIBUTOR.md
Browse files Browse the repository at this point in the history
  • Loading branch information
iDmple committed Oct 25, 2023
1 parent 665b14b commit 75e976a
Showing 1 changed file with 47 additions and 0 deletions.
47 changes: 47 additions & 0 deletions CONTRIBUTOR.md
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!

0 comments on commit 75e976a

Please sign in to comment.