Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
alisinabh authored Jan 22, 2025
1 parent 4b7263e commit c87efb2
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Contributing to Elixir Ethers

Thank you for your interest in contributing to Elixir Ethers! We welcome contributions from the community.

## How to Contribute

1. Fork the repository
2. Create a new branch for your feature or bugfix (`git checkout -b your-feature-name`)
3. Make your changes
4. Run the test suite (`mix test`)
5. Ensure code formatting is correct (`mix format`)
6. Commit your changes with a descriptive commit message
7. Push to your fork
8. Open a Pull Request

## Development Setup

1. Ensure you have Elixir installed
2. Clone the repository
3. Install and Run `anvil` (From https://getfoundry.sh/)
4. Install dependencies with `mix deps.get`
5. Run tests with `mix test`

## Pull Request Guidelines

- Include tests for any new functionality
- Update documentation as needed
- Follow the existing code style
- Keep your changes focused and atomic
- Write clear commit messages

## Questions or Issues?

If you have questions or run into issues, please open a GitHub issue with a clear description of the problem or question.

## License

By contributing to Elixir Ethers, you agree that your contributions will be licensed under its [License](/LICENSE).

0 comments on commit c87efb2

Please sign in to comment.