Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(code-of-conduct): adapt Contributor Covenant for project needs #96

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

ultimateownsz
Copy link
Collaborator

Documentation Pull Request Template

Summary

This PR modifies the project’s Code of Conduct to better align with the specific needs and values of the community. While the existing Code of Conduct was valuable, it felt overly restrictive. Clearer text and a more open approach have been added to ensure inclusivity while fostering collaboration and mutual respect. The updates aim to provide actionable guidelines while remaining flexible for diverse community interactions.

The updates include:

  • Adaptation of the Contributor Covenant v2.0.
  • Clarifications to ensure enforcement aligns with open-source principles.
  • Inclusion of a detailed attribution to acknowledge the original source while noting project-specific adjustments.

Related Issues

This PR issue(s)


✅ Checklist:

  • 📄 I have reviewed the documentation for grammar and spelling errors.
  • 📝 All links and references in the documentation are valid and functional.

Optional:

  • 📸 Screenshots, visuals, or diagrams have been added where applicable.
  • ✍️ Examples or code snippets are provided to clarify complex concepts (if applicable).

🏷️ Labels:

  • type: enhancement
  • type: documentation
  • game: ...

- Adapted the Contributor Covenant v2.0 to address specific values and requirements of the project.

- Added clarifications to align enforcement decisions with open-source community principles.

- Updated attribution to reflect both the original source and project-specific modifications.
@ultimateownsz ultimateownsz added enhancement New feature or request type: enhancement For adding new functionality or improving existing code type: documentation For PRs that update documentation labels Feb 7, 2025
ultimateownsz and others added 2 commits February 9, 2025 20:15
commit 60004a7
Merge: b694eca 7b98805
Author: Danilo <[email protected]>
Date:   Sun Feb 9 13:28:09 2025 +0100

    Remove old cli codebase to new repo (#95)

    # Code Pull Request Template

    ## Summary
    <!--
    INSTRUCTIONS:
    - Briefly describe the purpose of this pull request.
    -->
    This PR modifies the CLI codebase, all the old command line interface
    reference is removed and is moved to its own private repository for now.
    It will be made public later, to always have a reference to look at, or
    if you don't want to change code in pygame you can work in the classic
    repository.

    Also:
    - Moved an old unit test from the CLI codebase to that specific
    repository.
    - Some images we used as reference to create the board layout is moved
    to the other repository.
    - Furthermore I removed some other references that implicitly were used
    to have a launcher of some sorts.
    - Nothing is changed from the pygame loop, only the command line
    interface references!

    ## Related Issues
    <!--
    INSTRUCTIONS:
    - Mention related issue numbers here.
    - Example: "Fixes #123, Closes #456."
    -->

    This PR <!-- fixes|closes|addresses --> issue(s) <!-- (e.g., Fixes #123,
    Closes #456) -->

    ---

    <!-- ## Media
    # Add screenshots, GIFs, or videos if applicable. If not, delete this
    section.
    -->

    ## ✅ Checklist:

    - [x] 🛠️ I have tested my code, and it works as expected (e.g., game
    runs without errors).
    - [x] 📝 I have made sure that the code follows the project's formatting
    and style guidelines.

    Optional:
      - [ ] 💬 Code is commented (if applicable)

    ---

    ## 🏷️ Labels:
    <!--
    INSTRUCTIONS:
    - Add labels to describe the purpose of this PR.
    - Examples:
      - **Type**:
        - `type: enhancement` – For improving existing functionality.
        - `type: bug fix` – For fixing issues in the code.
        - `type: refactor` – For optimizing or cleaning up code.
        - `type: feature` – For adding new features.
      - **Area**:
        - `area: gameplay` – For changes affecting core game mechanics.
        - `area: assets` – For updates to sprites, textures, or UI.
        - `area: audio` – For sound effects or music updates.
      - **Game**:
    - `game: mechanics` – For changes to combat, movement, or game systems.
        - `game: UI` – For updates to the user interface or HUD.
        - `game: animations` – For animation-related changes.
    -->
      - `type: ...`
      - `area: ...`
      - `game: ...`

commit 7b98805
Author: ultimateownsz <[email protected]>
Date:   Tue Feb 4 21:07:22 2025 +0100

    fixed ruff formatter

    after running ruff it made the code more clear to read

commit 540062c
Author: ultimateownsz <[email protected]>
Date:   Tue Feb 4 20:41:25 2025 +0100

    moved old layout board to new repo

    these two files were used while creating the command line interface pyceas game

commit ef3c107
Author: ultimateownsz <[email protected]>
Date:   Tue Feb 4 20:34:32 2025 +0100

    removed old commented code

    this will remove the old reference to the different versions, to make it more clear that our main focus will be pygame

commit 57e4beb
Author: ultimateownsz <[email protected]>
Date:   Tue Feb 4 20:33:17 2025 +0100

    old codebase refs deleted

    all files are moved to its own repo, for now the repo is set to private to fix any issues before making it public
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request type: documentation For PRs that update documentation type: enhancement For adding new functionality or improving existing code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant