Skip to content

Latest commit

 

History

History
90 lines (58 loc) · 4.68 KB

CONTRIBUTING.md

File metadata and controls

90 lines (58 loc) · 4.68 KB

Contributing to Yuho

The following is a set of guidelines for contributing to Yuho lang spec, hosted here on GitHub.

These are guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table Of Contents

  1. Code of Conduct
  2. What should I know before I get started?
  3. How Can I Contribute?
  4. Styleguides
  5. FAQ

Code of Conduct

This project and everyone contributing to it is governed by this Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

What should I know before I get started?

  1. Read through the README file for prerequisites, installation details and configuration requirements.
  2. If you want to contribute, see here.
  3. If you have a question, see the FAQ before opening an issue. It could be answered already

How can I contribute?

Reporting Bugs

This section guides you through submitting a bug report for Yuho. Following these guidelines helps maintainers and the community...

  1. Understand your report
  2. Reproduce the behavior
  3. Find related reports

Guidelines for Reporting Bugs

  1. Perform a cursory search here for whether the issue has already been reported.
  2. If it has already been reported, add a comment to that issue instead of opening a new issue.
  3. If not already reported, please be as detailed as possible in describing the issue.
  4. Follow this template in the issue's description when opening a new issue.

Note

If you find a closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the new issue description.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for Yuho. Following these guidelines helps maintainers and the community...

  1. Understand your suggestion
  2. Gauge demand and popularity

Guidelines for Suggesting Enhancements

  1. Perform a cursory search here for whether the enhancement has already been suggested.
  2. If it has already been suggested, add a comment to that issue instead of opening a new issue.
  3. If not already suggested, please be as detailed as possible in describing the suggestion.
  4. Follow this template in the issue's description when opening a new issue.

Your First Code Contribution

Unsure where to begin contributing to Yuho? You can start by looking through these beginner and help-wanted issues:

  • Beginner issues: Issues which should only require a few lines of code, and a test or two.
  • Help wanted issues: Issues which should be a bit more involved than beginner issues.

As for how to contribute to Open Source projects, follow this guide for a step-by-step walkthrough of opening a pull request.

Other useful references

Styleguides

Git Commit Messages

We follow these guidelines to style commit messages. Keep them concise and informative.

Documentation Styleguide

Our documentation is written in Markdown, and we follow the Github Markdown Styleguide.

FAQ