Skip to content
This repository has been archived by the owner on Nov 21, 2024. It is now read-only.

Latest commit

 

History

History
108 lines (71 loc) · 2.78 KB

CONTRIBUTING.md

File metadata and controls

108 lines (71 loc) · 2.78 KB

🌟 Contributing to Cashubrew

First off, thank you for considering contributing to Cashubrew! It's people like you that make Cashubrew such a great tool. 🎉

🚀 Getting Started

Before you begin:

🍴 Forking the Repository

  1. Head over to the Cashubrew repository on GitHub
  2. Click the "Fork" button in the upper right corner
  3. Voilà! You now have your own copy of the repository

🛠 Setting Up Your Development Environment

  1. Clone your fork locally:
git clone https://github.com/your-username/cashubrew.git
cd cashubrew
  1. Add the original repository as a remote called "upstream":
git remote add upstream https://github.com/keep-starknet-strange/cashubrew.git
  1. Install dependencies:
mix deps.get
  1. Create a new branch for your feature or bugfix:
git checkout -b your-feature-name

💡 Making Changes

  1. Make your changes in your feature branch
  2. Write or adapt tests as needed
  3. Run the test suite to ensure everything is working:
mix test
  1. Make sure your code follows our style guide:
mix format
mix credo --strict
  1. Check for potential security issues:
mix sobelow
  1. Run static analysis:
mix dialyzer

📤 Submitting Changes

  1. Push your changes to your fork on GitHub:
git push origin your-feature-name
  1. Go to your fork on GitHub and click the "New Pull Request" button
  2. Ensure the base fork is AbdelStark/cashubrew and the base is main
  3. Give your pull request a clear title and description

🐛 Reporting Bugs

  1. Ensure the bug was not already reported by searching on GitHub under Issues
  2. If you're unable to find an open issue addressing the problem, open a new one

💡 Suggesting Enhancements

  1. Check the Issues page to see if the enhancement has already been suggested
  2. If not, create a new issue, clearly describing the enhancement and its potential benefits

📜 Commit Message Guidelines

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

❓ Questions?

Don't hesitate to reach out if you have any questions.

Thank you for contributing to Cashubrew! 🚀✨