Skip to content

Commit

Permalink
Merge pull request #6 from shahen94/shahen94-patch-1
Browse files Browse the repository at this point in the history
Create CONTRIBUTING.md
  • Loading branch information
shahen94 authored Mar 2, 2024
2 parents eca6f29 + 8284e4b commit ab2f09b
Showing 1 changed file with 58 additions and 0 deletions.
58 changes: 58 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# Contribution Guidelines

Thank you for considering contributing to our project! We welcome contributions from everyone.

Before making contributions, please ensure that:

1. Your code adheres to our formatting guidelines.
2. Your code passes all existing tests.
3. You have reviewed our existing documentation and have made updates if necessary.

## How to Contribute

1. Fork the repository to your GitHub account.
2. Clone the forked repository to your local machine:
```sh
git clone https://github.com/shahen94/craft
```
3. Create a new branch for your changes:
```sh
git checkout -b feature/your-feature
```
4. Make your changes and ensure they adhere to the project guidelines.
5. Commit your changes:
```sh
git commit -am "Add your descriptive commit message"
```
6. Push to your forked repository:
```sh
git push origin feature/your-feature
```
7. Create a new pull request on the original repository's GitHub page.

## Coding Guidelines

- Follow the existing coding style and conventions.
- Ensure your code is well-documented, especially for new features or changes.
- Make sure to write clear commit messages that describe the changes being made.

## Testing

- Before submitting a pull request, ensure that all existing tests pass.
- Write additional tests for new features or changes as necessary.

## Reporting Issues

If you encounter any bugs, issues, or have suggestions for improvements, please [open an issue](https://github.com/shahen94/craft/issues/new/choose) on our GitHub repository.

## Community Guidelines

Be respectful and considerate of others' contributions. We encourage constructive feedback and collaboration.

Thank you for your interest in contributing to our project!






0 comments on commit ab2f09b

Please sign in to comment.