Skip to content

Commit

Permalink
2024-02-05 01:34:12 dotfiles updates
Browse files Browse the repository at this point in the history
  • Loading branch information
psadi committed Feb 4, 2024
1 parent 5b4e4ee commit 53d32c9
Showing 1 changed file with 51 additions and 0 deletions.
51 changes: 51 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Contributing Guidelines

Thank you for considering contributing to this project! By participating in this open-source project, you agree to abide by the [contributor-covenant code of conduct](https://www.contributor-covenant.org/version/1/2/0/code-of-conduct).

## Table of Contents

- [Contributing Guidelines](#contributing-guidelines)
- [How to Contribute](#how-to-contribute)
- [Code Style](#code-style)
- [Testing](#testing)
- [Documentation](#documentation)
- [Review Process](#review-process)
- [Code of Conduct](#code-of-conduct)
- [Disclaimer](#disclaimer)

## How to Contribute

### Reporting Issues

If you encounter any issues or have suggestions for improvements, please check the existing issues to see if the topic has already been discussed. If not, feel free to open a new issue, providing as much detail as possible, including steps to reproduce the problem.

### Making Changes

If you'd like to contribute to the project:

1. Fork the repository to your GitHub account.
2. Create a new branch for your feature or bug fix.
3. Make your changes and ensure they are well-tested.
4. Commit your changes with clear and concise commit messages.
5. Push your branch to your fork.
6. Create a pull request against the `main` branch of this repository.

### Code Style

Follow the existing code style and formatting conventions in the project. If there's a specific style guide for a particular language or tool, adhere to it.

### Testing

Ensure that your changes are well-tested. If applicable, provide test cases to validate the correctness of your code.

### Documentation

Update the [README.md](README.md) file or any relevant documentation to reflect your changes. Clear and concise documentation is crucial for understanding the purpose and usage of your contribution.

### Review Process

All contributions will be reviewed before merging. Be open to feedback and be willing to make changes based on the feedback received.

## Code of Conduct

Please follow [contributor-covenant code of conduct](https://www.contributor-covenant.org/version/1/2/0/code-of-conduct) in all interactions, both within this project and in the larger open-source community.

0 comments on commit 53d32c9

Please sign in to comment.