Skip to content

Latest commit

 

History

History
53 lines (27 loc) · 2.9 KB

CONTRIBUTING.md

File metadata and controls

53 lines (27 loc) · 2.9 KB
Raw

Contributing to Lucas Vittor Blog

First off, thanks for taking the time to contribute!

The following is a set of guidelines for contributing to Lucas Vittor Blog, which is hosted on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

How Can I Contribute?

Reporting bugs

Bugs are tracked as GitHub issues. After you've determined where the bug is, create an issue and provide the following information by filling in the template.

Explain the problem and include additional details to help 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.

  • Provide specific examples to demonstrate the steps.

  • 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.

  • Include screenshots which show you following the described steps and clearly demonstrate the problem.

Reporting issues with content on blog posts

Content issues are tracked as GitHub issues. After you've determined where the issue is, create an issue and provide the following information by filling in the template.

Explain the content issues and provide the following information:

  • Use a clear and descriptive title for the issue to identify the suggestion.

  • Provide a step-by-step description of the recommended fix in as many details as possible.

  • Provide specific examples to demonstrate the steps.

Suggesting enhancements

Enhancement suggestions are tracked as GitHub issues. After you've determined the enhancement suggestions, create an issue and provide the following information by filling in the template.

Explain the enhancement suggestions and provide the following information:

  • 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.

  • Describe the current behavior and explain which behavior you expected to see instead and why.

  • Include screenshots which help you demonstrate the steps or point out the part of Lucas Vittor Blog which the suggestion is related to.