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

update documentation #94

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

update documentation #94

wants to merge 2 commits into from

Conversation

mustafasoylu
Copy link
Collaborator

After talking with some of our users, I wanted to update the documentation in several places.

  1. Set a note explaining they don't have to install somesy to their PC or add it as a dependency if they use it as a pre-commit hook.
  2. fix the version to the latest in the somesy.toml example
  3. add a note to warn users of the latest version
  4. explain why we set some fields as compulsory fields

When setting somesy up in the prototyping phase, we discussed the compulsory fields with Anton. It is not much, and a project should have at least that much metadata in its repository, else somesy doesn't mean anything anyway. However, we can discuss whether we should change the current compulsory fields.

Compulsory fields for project metadata:

  • name
  • description
  • version
  • license
  • people: at least 1 person

Compulsory fields for project metadata:

  • email
  • family names
  • given names

@mustafasoylu mustafasoylu added the documentation Improvements or additions to documentation label Jul 29, 2024
@mustafasoylu mustafasoylu requested a review from hofmannv July 29, 2024 08:56
@mustafasoylu mustafasoylu self-assigned this Jul 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant