Skip to content

Latest commit

 

History

History
72 lines (50 loc) · 3.29 KB

CONTRIBUTING.md

File metadata and controls

72 lines (50 loc) · 3.29 KB
Raw

Contributing to Story

Thank you for considering making contributions to Story and related repositories! Below you can find what's the best way that you can help.

Coding Guideline

Go coding guidelines

Good commit messages

Bug Reports

  • Ensure your issue has not already been reported. It may already be fixed!
  • Include the steps you carried out to produce the problem.
  • Include the behavior you observed along with the behavior you expected, and why you expected it.
  • Include any relevant stack traces or debugging output.

Feature Requests

We welcome feedback with or without pull requests. If you have an idea for how to improve the project, great! All we ask is that you take the time to write a clear and concise explanation of what need you are trying to solve. If you have thoughts on how it can be solved, include those too!

The best way to see a feature added, however, is to submit a pull request.

Pull Requests

  • Before creating your pull request, it's usually worth asking if the code you're planning on writing will actually be considered for merging. You can do this by opening an issue and asking. It may also help give the maintainers context for when the time comes to review your code.

  • Ensure your commit messages are well-written. This can double as your pull request message, so it pays to take the time to write a clear message.

  • Add tests for your feature. You should be able to look at other tests for examples. If you're unsure, don't hesitate to open an issue and ask!

  • Submit your pull request!

    • Fork the repository on GitHub.
    • Make your changes on your fork repository.
    • Submit a PR.

  • Each PR needs to link to a github issue. Please open a github issue first to describe the code changes you plan to make and the problem it solves. Then link the issue in your PR.

  • PR title and body follows conventional commit.

    • Title template: type(app/pkg): concise description
    • See allowed types
    • Description must be concise: lower case, no punctuation, no more than 50 characters.
    • Scope must be concise: only a one or two folders; e.g. 'client/cmd' or 'github' or '*'

Find something to work on

We are always in need of help, be it fixing documentation, reporting bugs or writing some code. Look at places where you feel best coding practices aren't followed, code refactoring is needed or tests are missing.

If you have questions about the development process, feel free to file an issue.

Code Review

To make it easier for your PR to receive reviews, consider the reviewers will need you to:

  • follow good coding guidelines.
  • write good commit messages.
  • break large changes into a logical series of smaller patches which individually make easily understandable changes, and in aggregate solve a broader issue.