Skip to content

Latest commit

 

History

History
68 lines (48 loc) · 2.79 KB

CONTRIBUTING.md

File metadata and controls

68 lines (48 loc) · 2.79 KB

Contributing

We accept all types of contributions and we are very welcoming to first time contributors.

Code of Conduct

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to streamplify@beryx.org.

How Can I Contribute?

  • report bugs
  • suggest enhancements
  • improve / write documentation
  • answer questions
  • promote the project
  • submit new unit tests
  • submit new examples
  • fix bugs
  • implement new features

up-for-grabs issues

Issues labeled up-for-grabs indicate tasks specifically chosen to be implemented by contributors. In most cases, these are new features and enhancements with clearly defined requirements, which makes them newcomer-friendly.

Please leave a message before starting to work on a task. This way, we can mark the issue as grabbed in order to prevent that two people work on the same thing.

If you claimed an issue and are no longer able to work on it, please tell us to make it available again.

Advice for newcomers: Don't be afraid to grab an issue, even if you're not sure you can implement it. Try your hand at it and don't hesitate to ask for clarification and guidance.

Code contributions

If you implement a new feature, your pull request should also contain:

Working on your first Pull Request?

You can learn how from this free series: How to Contribute to an Open Source Project on GitHub.

Development Tools

Command Line Build

Streamplify is built with Gradle and requires JDK 8 or higher. Clone the GitHub repository, cd into the top directory and start the build:

git clone https://github.com/beryx/streamplify.git
cd streamplify
./gradlew clean build            (On Windows: gradlew clean build)

IntelliJ Idea

  • make sure that the Groovy plugin is enabled
  • open build.gradle

Eclipse