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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

馃摑 Docs: Add pull request template #4

Closed
wants to merge 1 commit into from
Closed

馃摑 Docs: Add pull request template #4

wants to merge 1 commit into from

Conversation

ryanamay
Copy link
Contributor

@ryanamay ryanamay commented Sep 2, 2021

Description

Added a pull request template for use with future PRs.

Fixes none

  • Tick the box if the change requires a documentation update

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Others (please specify): Pull Request Template

How Has This Been Tested?

Is the code working on your side?

  • Yes
  • No (why?)

Test Configuration:

  • OS: N/A
  • Processor: N/A
  • IDE: N/A

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • Any dependent changes have been merged and published

Copy link
Collaborator

@angelofallars angelofallars left a comment

Choose a reason for hiding this comment

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

The pull request template is clean and informative.

However, in my experience as a volunteer software developer under an experienced software engineer and startup CEO, we did not utilize templates. The pull request format was free-form, allowing us to decide the layout of our pull requests.

I also regularly consult with a senior front-end developer at Etica Digital. They have no set template either in their company's private repository.

In addition, many of the members at Algo Drip are less familiar with Github and coding. It will be difficult for them to contribute code if they have to follow a long PR template.

We should go with the flow regarding pull requests for now. I will instruct the other members myself on a suggested (but not mandatory) pull request format.

Later on, as the project advances, we can decide if we will implement a pull request format.

@ryanamay
Copy link
Contributor Author

ryanamay commented Sep 2, 2021

ayt ayt

@ryanamay ryanamay closed this Sep 2, 2021
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.

None yet

2 participants