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

Elaborate on PR process for contributions #475

Merged
merged 8 commits into from
Jun 23, 2023

Conversation

benwandrew
Copy link
Collaborator

@benwandrew benwandrew commented Jun 22, 2023

Description

Adding small bit of language to make explicit the need to create a new branch for adding a contribution.

Type of change

  • docs: Documentation only changes

@@ -126,6 +127,9 @@ mkdocs serve

... then viewing the documentation using the link in your terminal.

### Create a new branch of the parent package

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Depending on weather you are member of the AutoRA organisation, to create a pull request, you need to fork the package and create a pull request from there. If you are not a member of the organisation you can not just create a branch.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good point! what about something like this?

Co-authored-by: Younes Strittmatter <[email protected]>
Copy link
Collaborator

@younesStrittmatter younesStrittmatter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@benwandrew benwandrew added this pull request to the merge queue Jun 23, 2023
Merged via the queue into main with commit fec3fa9 Jun 23, 2023
@benwandrew benwandrew deleted the docs/elaborate-on-PR-process-for-contributions branch June 23, 2023 11:51
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.

make sure to create add creating a new branch before adding PR to autora
2 participants