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

Added PR Template and update docs #2504

Merged
merged 8 commits into from
Nov 19, 2018
Merged

Conversation

ZeroX-DG
Copy link
Member

@ZeroX-DG ZeroX-DG commented Oct 18, 2018

Description

This PR added a pull request template and update docs to keep it up to date

Issue fixed

#2528

Type of changes

  • ⚪ Bug fix (Change that fixed an issue)
  • ⚪ Breaking change (Change that can cause existing functionality to change)
  • 🔘 Improvement (Change that improves the code. Maybe performance or development improvement)
  • ⚪ Feature (Change that adds new functionality)
  • 🔘 Documentation change (Change that modifies documentation. Maybe typo fixes)

Checklist:

  • ⚪ My code follows the project code style
  • ⚪ I have written test for my code and it has been tested
  • 🔘 All existing tests have been passed
  • ⚪ I have attached a screenshot/video to visualize my change if possible

@ZeroX-DG ZeroX-DG added the awaiting review ❇️ Pull request is awaiting a review. label Oct 18, 2018
@daiyam
Copy link
Contributor

daiyam commented Oct 19, 2018

@ZeroX-DG I like the template but I find the progress bar due to the checkboxes to be a little puzzling...

@ZeroX-DG
Copy link
Member Author

Yeah, I also feel a bit annoying 😠 What should I do? Do you have any idea @daiyam

<!--
Please make sure you fill in these checkboxes,
your PR will be reviewed faster if we know exactly what it does.
-->
Copy link
Contributor

Choose a reason for hiding this comment

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

@ZeroX-DG can you add the following text?

Put an `x` in all the boxes that apply.

Copy link
Member Author

Choose a reason for hiding this comment

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

@daiyam Thanks for the feedback, I've updated the message. Do you have any other idea?

@daiyam
Copy link
Contributor

daiyam commented Oct 21, 2018

@ZeroX-DG I have removed the - before the checkboxes in the PR #2506. It doesn't show up as a task list but it's still readable.

@ZeroX-DG
Copy link
Member Author

ZeroX-DG commented Oct 23, 2018

@daiyam It looks ugly 😢 Is there any other way? Maybe I'll just make a list of option in comment block and contributors can uncomment the applicable option

@daiyam
Copy link
Contributor

daiyam commented Oct 23, 2018

Maybe with emoticon:

  • 🔘 Bug fix (Change that fixed an issue)
  • ⚪ Breaking change (Change that can cause existing functionality to change)
  • ⚪ Improvement (Change that improves the code. Maybe performance or development improvement)
  • ⚪ Feature (Change that adds new functionality)
  • ⚪ Documentation change (Change that modifies documentation. Maybe typo fixes)
- :radio_button: Bug fix (Change that fixed an issue)
- :white_circle: Breaking change (Change that can cause existing functionality to change)
- :white_circle: Improvement (Change that improves the code. Maybe performance or development improvement)
- :white_circle: Feature (Change that adds new functionality)
- :white_circle: Documentation change (Change that modifies documentation. Maybe typo fixes)

@ZeroX-DG
Copy link
Member Author

Oh, that's a brilliant idea! I'll update it soon

@jangtsekiang
Copy link

@ZeroX-DG ,
Can you create a link for "My code follows the project code style"?

@ZeroX-DG
Copy link
Member Author

@jangtsekiang I have added a link and created a doc for code style in this PR.

@ZeroX-DG ZeroX-DG changed the title Added PR Template Added PR Template and update docs Oct 26, 2018
@daiyam
Copy link
Contributor

daiyam commented Nov 15, 2018

When will it be merged?

@ZeroX-DG
Copy link
Member Author

I'm not sure, @Rokt33r is pretty busy.

@Rokt33r Rokt33r merged commit b703c42 into BoostIO:master Nov 19, 2018
@Rokt33r Rokt33r added next release (v0.11.12) and removed awaiting review ❇️ Pull request is awaiting a review. labels Nov 19, 2018
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.

4 participants