Skip to content

Latest commit

 

History

History
126 lines (84 loc) · 6.91 KB

CONTRIBUTING.md

File metadata and controls

126 lines (84 loc) · 6.91 KB
Raw

Contributing to Rokkit.ts

🎊 Thanks to contribute to Rokkit.ts. 🎊
Contributers like YOU are the reason why the open source community is so great and why we can build awesome software projects like Rokkit.ts. 🎉

Table of Content

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct.
By participating, you are expected to uphold this code. Please report unacceptable behavior to saint740@googlemail.com.

How Can I contribute?

There are different types of contributions that you can tackle.
In the following we state different options how to contribute to the project.

Before submitting any contribution please check which part of the framework (repository) is related.
Currently the project is split up into two different categories which contain the different parts:

  1. Feature Modules

    • Rokkit.ts Core
    • Rokkit.ts Web

  2. Infrastructure Modules

    • Rokkit.ts Dependency Injection
    • Rokkit.ts Logger
    • Rokkit.ts Abstract Module

Make sure that your contribution fits the correct project part, this helps us to maintain the project and continue to grow the project. 😁

Reporting Bugs

The following will guide you through the process on how to create a bug for Rokkit.ts. The following guidelines helps the community and the maintainers to understand and hopefully solve the problem faster. Please try to include as many information as possible.

Before I submit a Bug

Please check the list in order to submit a new bug:

  • Check if the problem belongs to Rokkit.ts, try to debug you application and see if you can find a fix by yourself.
  • Can you reproduce the bug? Please note down any steps needed to create the bug.
  • Determine which repository the problem should be reported in.
  • Please search for similar issues that are allready reported. If you find any corrolated bugs please add a comment instead of creating a new one.

How Do I Submit A (Good) Bug Report?

Bugs are tracked as GitHub issues. After you've determined which repository your bug is related to, create an issue on that repository and provide the following information by filling in the issue template.

Explain the problem and include additional details to help maintainers reproduce the problem:

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible. When listing steps, don't just say what you did, but explain how you did it.
  • Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.
  • State the used versions for Rokkit.ts, TypeScript and Node.js.
  • If the problem wasn't triggered by a specific action, describe what you were doing before the problem happened and share more information using the guidelines below.

Suggesting Enhancements

We will guide you through the process on how to suggest enhancements to the project. These guidelines helps us to evaluate and discuss your ideas faster and may include it in future version of the framework.

Before I submit a suggestion for an enhancement

  • Check that your enhancement is not support by any module of the framework.
  • Determine to which repository your enhancement belongs
  • Search for similar enhancements that are already described in a repository

How Do I Submit A (Good) suggestion for an enhancement?

Enhancements are tracked as GitHub issues. After you've determined which repository your enhancement is related to, create an issue on that repository and provide the following information in the feature request template.

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • List some other frameworks or libraries where this enhancement exists.

Your First Code Contribution

You are unsure where to begin contributing? You can start by looking through beginner friendly issues:

Beginner issues - issues which should only require a few lines of code, and a test or two.

There will be issues that are labeled as beginner friendly within the different repositories, just have a look and try to tackle one of these!

Pull Requests

In order to fix a bug or implement any new enhancement you need to open an oull request. If you contribution should be ocnsidered by the maintainers please follow the list below:

  1. Copy the pull request template and fill it.
  2. Implement your solution, please consider to write test and align with the given code style.
  3. Follow our style guide for documentation and commit messages

While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Rename Controller to..." not "Renames Controller to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

Acknoledgement

This contribution guidelines are inspired by the Atom contribution guidelines.