Skip to content

Contributing guidelines #73

@Oakchris1955

Description

@Oakchris1955

Since this issue was partly raised in #52, I have made an attempt at writing some basic contributing guidelines by copying Learnix book's guidelines to some degree. I don't expect them to be added as-is, that's why I opened this issue, so discussion about them can occur here.

P.S.

  1. I see there is a backlog for features that have or will be implemented. Perhaps is should also be mentioned?
  2. if you are gonna create a CONTRIBUTING file, please mention me with the Co-authored-by: Oakchris1955 <chris@oakchris1955.eu> trailer at the end of the commit message

CONTRIBUTING.md:

# Contributing to LearnixOS

Thank you for your interest in this project! To ensure this project maintains a consistent voice and adheres to its licensing, please follow these guidelines.

---

## License

By contributing to this project, you agree that your contributions will be dual-licensed under the:

- MIT License ([LICENSE-MIT](LICENSE-MIT))
- Apache License 2.0 ([LICENSE-APACHE](LICENSE-APACHE))

This license ensures the work remains free for the public to read in its intended form or modify and distribute it
as one wishes, while preserving copyright.

## Ownership of Contributions

By submitting a contribution (e.g., a Pull Request, Issue or a Commit), you agree that:

1. You grant the project owner a perpetual, worldwide, royalty-free license to use,
   incorporate, and sell the work including your suggestions.
2. You acknowledge that you have no claim to royalties or commercial compensation
   resulting from the sale of this book.

## Scope of Contributions

`TODO`

## Policy on AI and LLMs

This book is a human-authored work. To preserve the unique style and "soul" of the project:

1. **Human-Only contributions:** Any suggestions for changes should be your own original thought.
2. **No LLMs:** Please do **not** use Large Language Models (such as ChatGPT, Claude, or Gemini) to write code for this project and limit the use of them just to typo or grammar checking.
3. **Standard Tools:** The use of basic spell-checkers or standard dictionary tools is perfectly acceptable.

## Submitting issues

1. **Search:** Check the "Issues" tab to see if the error has already been reported.
2. **Report:** If you find a typo, open an **Issue** or submit a **Pull Request**.
3. **Be Specific:** Clearly state the current text, the suggested change, and the chapter/page where it was found.

## Implementing features

If you feel like you can help implement a missing feature that is described in an issue, leave a word under the
relevant issue.

Thank you for your help in refining this work!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    Status
    Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions