Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
66 lines (50 loc) · 2.37 KB

CONTRIBUTING.md

File metadata and controls

66 lines (50 loc) · 2.37 KB
Raw

Contributing to the Lean Storytelling book

Thank you for your interest in contributing to Lean Storytelling!

Important

Whether you're fixing a typo, adding a new example, or proposing a major change, your contributions are welcome.

Table of Contents

How to Contribute

Reporting Issues

  • Use the issue tracker to report bugs, suggest improvements, or ask questions.
  • Provide as much detail as possible, including steps to reproduce the issue.

Submitting Changes

  1. Fork the Repository: Create your own fork of the repository.
  2. Create a Branch: Work on a new branch for your changes.
  3. Make Changes: Write clear, concise, and well-structured content.
  4. Commit Changes: Use descriptive commit messages.
  5. Submit a Pull Request: Open a pull request to the main repository.

Writing Style

  • Follow the existing writing style in the repository.
  • Use clear, concise language.
  • Keep sentences and paragraphs short.
  • Use headers and lists to organize content.

Code of Conduct

  • Be respectful and considerate in all interactions.
  • Follow the Contributor Covenant code of conduct.

Files and Folders Structure

Hierarchy of Files and Folders

/src
  SUMMARY.md
/docs
README.md
CONTRIBUTING.md
book.toml

Explanation of Files and Folders

  1. /src: The root directory for the Lean Storytelling book in md files and folders.
  2. SUMMARY.md: Main file for mdbook.
  3. /docs: Static site for the book, built with mdbook.
  4. README.md: Overview of the Lean Storytelling book.
  5. CONTRIBUTING.md: This file outlines guidelines for contributing to the book.
  6. book.toml: This file specifies how to build the static site with mdbook.

License

By contributing to Lean Storytelling, you agree that your contributions will be licensed under the Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.