Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
52 lines (37 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

52 lines (37 loc) · 1.42 KB

Contributing to Dataverse DevKit

Thank you for your interest in contributing to Dataverse DevKit!

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/your-username/DataverseDevKit.git
  3. Create a feature branch: git checkout -b feature/my-feature
  4. Make your changes
  5. Run tests and linters
  6. Commit with clear messages
  7. Push and create a pull request

Development Setup

See docs/development.md for detailed setup instructions.

Code Style

  • C#: Follow .editorconfig rules; code analysis is enforced
  • TypeScript: Use ESLint and Prettier (run pnpm lint and pnpm format)
  • Write descriptive commit messages
  • Add tests for new features
  • Update documentation as needed

Pull Request Process

  1. Ensure all tests pass and code is properly formatted
  2. Update README.md or docs if you've changed functionality
  3. Reference any related issues in your PR description
  4. Wait for review from maintainers
  5. Address feedback and update your PR

Reporting Bugs

Use the GitHub issue tracker and include:

  • Clear description of the issue
  • Steps to reproduce
  • Expected vs actual behavior
  • Environment details (OS, .NET version, etc.)

Feature Requests

We welcome feature requests! Please:

  • Search existing issues first
  • Describe the use case and benefits
  • Consider if it fits the project's goals

Questions?

Open a discussion or issue on GitHub.