Skip to content

Commit f887cc9

Browse files
authored
Create CONTRIBUTING.md
1 parent 651d150 commit f887cc9

File tree

1 file changed

+81
-0
lines changed

1 file changed

+81
-0
lines changed

CONTRIBUTING.md

+81
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
# Contributing to infinistore
2+
3+
Thank you for your interest in contributing to infinistore! We welcome all contributions, whether it's fixing bugs, adding new features, improving documentation, or helping others in the community.
4+
5+
## Table of Contents
6+
7+
- [Getting Started](#getting-started)
8+
- [Code of Conduct](#code-of-conduct)
9+
- [How to Contribute](#how-to-contribute)
10+
- [Reporting Issues](#reporting-issues)
11+
- [Suggesting Enhancements](#suggesting-enhancements)
12+
- [Submitting Changes](#submitting-changes)
13+
- [Code Style Guidelines](#code-style-guidelines)
14+
- [Development Workflow](#development-workflow)
15+
- [License](#license)
16+
17+
## Getting Started
18+
19+
To get started with contributing, please follow these steps:
20+
21+
1. Fork the repository and clone it to your local machine.
22+
2. Set up your development environment following the [installation guide](./docs/INSTALLATION.md).
23+
3. Create a new branch for your changes.
24+
25+
## Code of Conduct
26+
27+
This project adheres to the [Contributor Covenant Code of Conduct](./CODE_OF_CONDUCT.md). By participating, you agree to abide by its terms.
28+
29+
## How to Contribute
30+
31+
### Reporting Issues
32+
33+
If you find a bug or have a feature request, please open an issue in the [issue tracker](https://github.com/bd-iaas-us/infiniStore/issues) with the following details:
34+
35+
- A clear and descriptive title.
36+
- Steps to reproduce the issue (if applicable).
37+
- Expected vs. actual behavior.
38+
- Any relevant logs, screenshots, or code snippets.
39+
40+
### Suggesting Enhancements
41+
42+
We welcome suggestions for new features and improvements! Before submitting an enhancement request, please check if a similar idea has already been proposed. If not, open a new issue describing:
43+
44+
- The problem or limitation you are trying to solve.
45+
- A possible solution or implementation.
46+
- Any alternative approaches considered.
47+
48+
### Submitting Changes
49+
50+
1. Fork the repository and create a new branch for your changes:
51+
```sh
52+
git checkout -b feature-or-fix-name
53+
```
54+
2. Make your modifications and commit them:
55+
```sh
56+
git commit -m "Description of changes"
57+
```
58+
3. Push your branch to your fork and open a pull request:
59+
```sh
60+
git push origin feature-or-fix-name
61+
```
62+
4. In your pull request, provide a clear explanation of the changes.
63+
64+
### Code Style Guidelines
65+
66+
- Follow the existing code style in the project.
67+
- Use meaningful commit messages.
68+
- Ensure all tests pass before submitting.
69+
- Run the linter (if applicable) before committing.
70+
71+
## Development Workflow
72+
73+
1. Clone the repository and install dependencies.
74+
2. Run tests locally before submitting changes.
75+
3. If adding new functionality, update the documentation accordingly.
76+
4. Ensure your branch is up to date with the latest `main` branch before submitting a PR.
77+
5. Work with reviewers to address feedback.
78+
79+
## License
80+
81+
By contributing to this project, you agree that your contributions will be licensed under the same license as the project ([Apache 2.0](./LICENSE)).

0 commit comments

Comments
 (0)