Skip to content

Commit c87efb2

Browse files
authored
Create CONTRIBUTING.md
1 parent 4b7263e commit c87efb2

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

CONTRIBUTING.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Contributing to Elixir Ethers
2+
3+
Thank you for your interest in contributing to Elixir Ethers! We welcome contributions from the community.
4+
5+
## How to Contribute
6+
7+
1. Fork the repository
8+
2. Create a new branch for your feature or bugfix (`git checkout -b your-feature-name`)
9+
3. Make your changes
10+
4. Run the test suite (`mix test`)
11+
5. Ensure code formatting is correct (`mix format`)
12+
6. Commit your changes with a descriptive commit message
13+
7. Push to your fork
14+
8. Open a Pull Request
15+
16+
## Development Setup
17+
18+
1. Ensure you have Elixir installed
19+
2. Clone the repository
20+
3. Install and Run `anvil` (From https://getfoundry.sh/)
21+
4. Install dependencies with `mix deps.get`
22+
5. Run tests with `mix test`
23+
24+
## Pull Request Guidelines
25+
26+
- Include tests for any new functionality
27+
- Update documentation as needed
28+
- Follow the existing code style
29+
- Keep your changes focused and atomic
30+
- Write clear commit messages
31+
32+
## Questions or Issues?
33+
34+
If you have questions or run into issues, please open a GitHub issue with a clear description of the problem or question.
35+
36+
## License
37+
38+
By contributing to Elixir Ethers, you agree that your contributions will be licensed under its [License](/LICENSE).

0 commit comments

Comments
 (0)