Skip to content

Latest commit

 

History

History
60 lines (47 loc) · 2.87 KB

CONTRIBUTING.md

File metadata and controls

60 lines (47 loc) · 2.87 KB
Raw

Contributing

This document describes what you can do to contribute to the project, how to go about that, and what is expected of you.

Please also refer to our Code of Conduct.

Note: the project is currently at an early stage, so it's generally advisable to contact us before you contribute.

Things you could do

There are several ways you can contribute to the project. To give you a quick idea:

  • Development
    • Implement or enhance features.
    • Increase test coverage.
    • Perform small refactors.
  • Transformation specification
    • Help us map highly expressive semantic models onto technical models.
  • Documentation
    • Improve the Wiki and project documents.
  • Engage
    • Report bugs.
    • Submit requests for new features or enhancements.
    • Share your thoughts on discussions and issues.
    • Help us promote the project and find new users and contributors.

How to contribute

Preliminaries

First, some preliminary reading:

  • Make sure you're familiar with our Way of Working, most notably how we use GitHub's Issues, Discussions and Projects.
  • If you plan to make changes to code or documentation, read our Guidelines as well.

Steps to take

Then, follow these steps to guide you through the process.

  1. Check out currently existing issues and discussions. Look at Issues and Discussions.
    • Maybe what you consider doing is already being worked on, or at least there might be an issue for it.
    • It may inspire or influence you to gain new ideas, or to revise your current one(s).
  2. Create an issue or discussion where you describe your idea. If a suitable issue/discussion exists already, carry on from there.
    • This way we maintain an overview of our work inventory and planning.
    • It encourages you to think well about what it is you wish to contribute.
    • Others can help you refine and discuss your idea.
    • If for some reason you wish to deviate from this way of working, you are free to do so at own risk of rejection.

If your contribution involves making actual changes to the code or documentation, please continue reading.

  1. Make changes to the files on your own fork of the project.
    • Make sure your changes conform to our Guidelines.
    • Note that changes to the Wiki are a separate case. Please contact us if that's what you wish to do.
  2. Submit a pull request when you feel confident the work is done.
    • The maintainers will review your code and request changes if necessary.
    • As soon as the changes are approved, your code will be merged.
  3. Close associated issues, discussions and pull requests.
    • Clean up after yourself!