-
Notifications
You must be signed in to change notification settings - Fork 14
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
Add: First time contributors content #130
Conversation
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@DanielaIgRo I added some comments there.
I made the comments in the md file because I forgot to use reviewnb XD sorry
in general lines, I think it would be good to add information as well about:
- pre-commit
- explain what is pre-commit, how to install that (pre-commit install), and how to run it for all files (pre-commit run --all-files)
- linter
- what is linter (https://www.sonarsource.com/learn/linter/), and examples: (ruff, black, flake8, mypy, pydocstyle, isort, vulture, mccabe, bandit ) (refs: https://github.com/orgs/PyCQA/repositories?type=all)
- documentation
- why is it necessary to create a documentation
- some options for creating a documentation for your project: sphinx, mkdocs, quarto
- recommend a ref for improving skill on writting documentation: https://diataxis.fr/ and https://www.writethedocs.org/slack/
- CI
- what is CI
- recommend some options: github actions, azure, circleci, travisci
- unit tests
- why use unittest
- recommend some options for unittest: pytest, unittest, hypothesis
- and it would be nice to mention about project templates for new projects, and mention about scicookie for python projects, and cookicutter
also it is nice to mention something about communication .. I will try to find something for that
here are some refs about communication for open source projects (I didn't read any of them): |
@xmnlab PR ready for a new Review |
info sobre flow options for git:
OSL recommend the github flow |
merge commit vs rebase OSL recommend the usage of git rebase note: |
options for virtual environment:
|
@xmnlab it's ready for a new review |
@xmnlab I hope this commit be ok |
5bb44a7
to
9c38162
Compare
@DanielaIgRo your branch is out-of-date, could you rebase it on top of the upstream/main please? |
Hey, thanks for the info
I already do it
|
b3336ef
to
1dcf5f4
Compare
9e77561
to
2a2e7a8
Compare
@xmnlab Ready for a review. Hope the last one hehe |
@xmnlab I forgot the conclusion. Now is done |
|
||
These key features make ArtBox an great tool for multimedia enthusiasts, content creators, and anyone seeking efficient and user-friendly solutions for multimedia file manipulation. Explore the possibilities with ArtBox and elevate your multimedia processing capabilities. | ||
|
||
Key features of ArtBox include capabilities for text-to-audio conversion, YouTube video downloading, musical composition from notes, audio removal from video clips, audio extraction, and merging audio with video files. These functionalities position ArtBox as a pivotal tool for multimedia enthusiasts, content creators, and anyone in need of efficient multimedia processing solutions. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@DanielaIgRo I don't thing this change should be in this PR, maybe you included that by mistake
@DanielaIgRo , thanks for working on that. |
#97
PR about content for the page First Time Contributors
Please add the points or make the corrections if need it