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

Restructured README file for Onboarding #1758

Draft
wants to merge 6 commits into
base: develop
Choose a base branch
from

Conversation

schrpa
Copy link

@schrpa schrpa commented Jul 15, 2022

Moved the content of the README.md license section to the about section of the repository:
"License of our Project (mainly AGPL v3)"
This issue was discussed with Stefan and we decided to add the AGPL v3 license to the about section and remove it from the README.md.

Added onboarding.md file to implement onboarding step-by-step guide later. Needed now to enable linking from README file (start contributing link).

Changed README file as discussed in the prototype.

Your checklist for this pull request

Please review the contributing guidelines and wiki pages of this repository.

  • Include the name of the Jira ticket in the PR’s title
  • Verify that the Jira ticket is in the status Ready for Development
  • Include a summary of the changes plus the relevant context
  • Choose the proper base branch (develop)
  • Confirm that the changes follow the project’s coding guidelines
  • Verify that the changes generate no compiler or linter warnings
  • Perform a self-review of the changes
  • Verify to commit no other files than the intentionally changed ones
  • Include reasonable and readable tests verifying the added or changed behavior
  • Confirm that new and existing unit tests pass locally
  • Check that the commits’ message style matches the project’s guideline
  • Stick to the project’s git workflow (rebase and squash your commits)
  • Verify that your changes do not have any conflicts with the base branch
  • After the PR, verify that all CI checks have passed
  • Post a message in the #catty Slack channel and ask for a code reviewer

schrpa added 4 commits July 15, 2022 14:43
This file is needed for the link in the README file and will contain all necessary information for newcomers in the future.
Moving the content of the README.md license section to the about section of the repository:
"License of our Project (mainly AGPL v3)"
Changed the file as discussed in the prototype.
Changed link in "start contribution" section to point to Catroweb repository of Catrobat.
@schrpa schrpa marked this pull request as draft July 16, 2022 05:59
schrpa added 2 commits August 5, 2022 12:50
Changed all issues on Jira filter
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant