Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
52 lines (34 loc) · 1.49 KB

CONTRIBUTING.md

File metadata and controls

52 lines (34 loc) · 1.49 KB

Contributing

Thank you for your interest in contributing to Forum Virium Helsinki projects.

Getting Started

  1. Check the repository's README.md for project-specific setup instructions
  2. Look for issues labeled good first issue or help wanted
  3. Open an issue before starting large changes to discuss the approach

Development Workflow

  1. Fork the repository and create a feature branch from main
  2. Make your changes following the project's coding conventions
  3. Write or update tests as appropriate
  4. Ensure all tests pass and linting is clean
  5. Open a pull request against main

Commit Messages

We use Conventional Commits:

type(scope): short description

Optional longer description.

Refs #123

Types: feat, fix, docs, style, refactor, test, chore, ci, perf

Breaking changes: add ! after the type or include BREAKING CHANGE: in the footer.

Pull Requests

  • Keep PRs focused on a single change
  • Reference related issues in the PR description
  • Respond to review feedback promptly
  • Squash fixup commits before merge

Reporting Issues

Use the issue templates provided in each repository. Include:

  • Clear description of the problem or request
  • Steps to reproduce (for bugs)
  • Expected vs actual behavior
  • Relevant environment details

Questions

For questions about a specific project, open an issue in that repository. For general questions about Forum Virium Helsinki development, contact info@forumvirium.fi.