Skip to content

Latest commit

 

History

History
55 lines (32 loc) · 2.05 KB

CONTRIBUTING.md

File metadata and controls

55 lines (32 loc) · 2.05 KB

How to contribute to Superface Station

We welcome contributions to our open source project on GitHub.

Please open an issue first if you want to make larger changes

Introduction

We are glad that you are interested in Superface in the way of contributing. We value the pro-community developers as you are.

Help the community

  1. Report an Error or a Bug
  2. Contribute to the Documentation
  3. Provide Support on Issues

Need help?

If you have any question about this project (for example, how to use it) or if you just need some clarification about anything, please open an Issue at Issues.

Contributing

Follow these steps:

  1. Fork & Clone the repository
  2. Setup the Station
  3. Commit changes to your own branch by convention. See https://www.conventionalcommits.org/en/v1.0.0/
  4. Push your work back up to your fork
  5. Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest from "upstream" before making a pull request.

NOTE: Please open an issue first if you want to make larger changes

Contribute by adding use-case

For help with authoring new use-case see Superface documentation.

In Station we want to keep use-cases which are consistent and in great quality. To achieve it, set of convetions were created.

Contribute by reporting bugs

If you are experiencing bug or undocumented behavior please open an Issue with bug template at Issues.

Contribute to documentation

Help us improve Superface documentation, you can report typos, improve examples.

NOTE: If editing the README, please conform to the standard-readme specification.

Copyright and Licensing

The Superface Station open source project is licensed under the MIT License.