Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
119 lines (80 loc) · 5.67 KB

CONTRIBUTING.md

File metadata and controls

119 lines (80 loc) · 5.67 KB

Contributing to Create SPL

First off, thanks for taking the time to contribute! 🎉

The following is a set of guidelines for contributing to Create SPL. These are mostly 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. How Can I Contribute?
  3. Style Guides
  4. Additional Notes

Code of Conduct

This project and everyone participating in it is governed by the Create SPL Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to the author.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for Create SPL. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

Before Submitting a Bug Report

  • Check the issues to see if the problem has already been reported. If it has and the issue is still open, add a comment to the existing issue instead of opening a new one.

How Do I Submit a (Good) Bug Report?

Bugs are tracked as GitHub issues. Create an issue and provide the following information by filling in the template:

  • 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.
  • Include screenshots which show you following the described steps and clearly demonstrate the problem.
  • 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.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for Create SPL, including completely new features and minor improvements to existing functionality.

Before Submitting an Enhancement Suggestion

  • Check the issues to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.

How Do I Submit a (Good) Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues. Create an issue and provide the following information by filling in the 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.
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • Include screenshots to help demonstrate the steps or desired enhancement.

Pull Requests

The process described here has several goals:

  • Maintain Create SPL's quality
  • Fix problems that are important to users
  • Engage the community in working toward the best possible Create SPL
  • Enable a sustainable system for Create SPL's maintainers to review contributions

Your First Pull Request

  1. Fork the repository and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

Working on Your First Pull Request?

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

Style Guides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line
  • Consider starting the commit message with an applicable emoji:
    • 🎉 :tada: for initial commits
    • 🐛 :bug: for bug fixes
    • 📝 :memo: for documentation
    • ✨ :sparkles: for new features

Coding Standards

  • Follow Create SPL's coding conventions and guidelines.
  • Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  • Ensure all tests pass.

Additional Notes

Issue and Pull Request Labels

This section lists the labels we use to help us track and manage issues and pull requests.

  • bug: Confirmed bugs or reports that are very likely to be bugs.
  • duplicate: Issues or pull requests that are duplicates of other issues or pull requests.
  • enhancement: Feature requests.
  • good first issue: Issues that should be relatively straightforward to address and are a good place to start for newcomers.
  • help wanted: Issues that should be a bit more involved than good first issue ones.

We use other labels to help us organize and prioritize issues and pull requests. Feel free to suggest new labels or changes to existing ones.

Thank you for contributing to Create Spl!