Skip to content

Latest commit

 

History

History
65 lines (40 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

65 lines (40 loc) · 1.59 KB

Contributing

We welcome contributions to Stroma! This guide will help you get started with contributing to the project.

Getting Started

Before you begin, please make sure you have a GitHub account and are familiar with Git workflows.

Contribution Workflow

1. Fork the Repository

Start by forking the Stroma repository to your GitHub account.

2. Clone Your Fork

git clone https://github.com/YOUR_USERNAME/stroma.git
cd stroma

3. Create a Feature Branch

git checkout -b my-new-feature

Use a descriptive branch name that reflects the changes you're making (e.g., fix-validation-bug, add-logging-support).

4. Make Your Changes

  • Write clean, readable code that follows the project's coding standards
  • Add tests for new functionality
  • Update documentation as needed

5. Commit Your Changes

git commit -am "Add some feature"

Write clear, concise commit messages that describe what changed and why.

6. Push to Your Fork

git push origin my-new-feature

7. Create a Pull Request

Visit the original repository and create a new Pull Request from your feature branch.

In your PR description:

  • Clearly describe the changes you've made
  • Reference any related issues
  • Explain the reasoning behind your approach

Questions?

If you have questions about contributing, feel free to open an issue in the main repository.

Thank you for contributing to Stroma! 🎉