Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
37 lines (28 loc) · 1.87 KB

CONTRIBUTING.md

File metadata and controls

37 lines (28 loc) · 1.87 KB
Raw

Contributing

Contributions are welcome - code, docs, whatever it might be! If this is your first contribution to an Open Source project or you're a core maintainer of multiple projects, your time and interest in contributing to this project is most welcome.

As a general rule;

  • If a change is less than 3 lines: You're probably safe just to submit the change without a discussion. This includes typos, dependency changes, and quick fixes, etc.
  • If a change is more than 3 lines: It's probably best to discuss the change in an issue or on discord first. This is simply because you might not be aware of the roadmap for the project, or understand the impact this change might have. We're just trying to save you time here, and importantly, avoid you being disappointed if your change isn't accepted.

Types of Contributions

Contributions can include:

  • Code improvements: Fixing bugs or adding new features.
  • Documentation updates: Enhancing clarity or adding missing information.
  • Feature requests: Suggesting new capabilities or integrations.
  • Bug reports: Identifying and reporting issues.

How to contribute

This project follows a Fork/Feature Branch/Pull Request model. If you're not familiar with this, here's how it works:

  1. Fork the project: Create a personal copy of the repository on your GitHub account.
  2. Clone your fork: Bring a copy of your fork to your local machine. 
    git clone https://github.com/YOUR_USERNAME/micracode.git
  3. Create a new branch: Start a new branch for your changes 
    git checkout -b feature/your-feature-name
  4. Make your changes: Implement the changes you wish to contribute.
  5. Push your changes: Upload your changes to your fork. 
    git push -u origin feature/your-feature-name
  6. Create a pull request: Propose your changes to the main branch.