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

perf(documentation): Adding structure and content to guide.md #150

Merged
merged 3 commits into from
Jul 22, 2023

Conversation

Anavelyz
Copy link
Collaborator

@Anavelyz Anavelyz commented Jul 22, 2023

Pull Request description

The purpose of this PR is to add the documentation associated with the TUI elements and some information that may be useful to the user of the template.

Information added:

  • Structure for SciCookie user guide
  • Notes about the text-based user interface (TUI)
  • Introduction for Project settings and Project tools
  • Information for:
    • Project layout
    • Build system
    • bandit
    • black
    • coverage
    • flake8
    • ruff
    • Docker
    • Podman
    • kubernetes [*]
    • Code of conduct
    • Governance document
    • Roadmap document
    • Control Version
  • Improving information about pytest and hypothesis.
  • Fix a typo in the template README.md

[*] I added information, but I don't think it's implemented (confirm @xmnlab)

@YurelyCamacho will continue to add more information :D

Pull Request checklists

This PR is a:

  • bug-fix
  • new feature
  • maintenance

About this PR:

  • it includes tests.
  • the tests are executed on CI.
  • the tests generate log file(s) (path).
  • pre-commit hooks were executed locally.
  • this PR requires a project documentation update.

Author's checklist:

  • I have reviewed the changes and it contains no misspelling.
  • The code is well commented, especially in the parts that contain more complexity.
  • New and old tests passed locally.

Reviewer's Checklist

  • I managed to reproduce the problem locally from the main branch
  • I managed to test the new changes locally
  • I confirm that the issues mentioned were fixed/resolved.

@Anavelyz
Copy link
Collaborator Author

@xmnlab @YurelyCamacho @EverVino Please check the added information. Thank you 😃

docs/guide.md Outdated Show resolved Hide resolved
@EverVino
Copy link

Look good to me

@xmnlab xmnlab merged commit fe9ce87 into osl-incubator:main Jul 22, 2023
11 checks passed
@xmnlab
Copy link
Member

xmnlab commented Jul 22, 2023

thanks @Anavelyz !
and thanks @YurelyCamacho and @EverVino for the review!

@github-actions
Copy link

🎉 This PR is included in version 0.4.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants