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

[feat/fix/docs]: Improve code to follow CI/repo rules #903

Closed

Conversation

Panquesito7
Copy link
Member

Description of Change

Add a bit of documentation in various files.
Improve code to use C++ standard libraries, and respect repo rules and CI.

This pull request is still WIP.
I will still make more changes.

Checklist

  • Added description of change
  • Relevant documentation/comments is changed or added
  • PR title follows semantic commit guidelines
  • Search previous suggestions before making a new one, as yours may be a duplicate.
  • I acknowledge that all my contributions will be made under the project's license.

Notes: Forgot to split commits per change, apologizes.

Forgot to split commits per change, apologizes!
@kvedala
Copy link
Collaborator

kvedala commented Jun 25, 2020

please split this commit bac4e70 and 2a44ee3 Will be difficult to revert or make any changes otherwise.

@kvedala
Copy link
Collaborator

kvedala commented Jun 25, 2020

Description of Change

Add a bit of documentation in various files.
Improve code to use C++ standard libraries, and respect repo rules and CI.

This pull request is still WIP.
I will still make more changes.

Checklist

  • Added description of change
  • Relevant documentation/comments is changed or added
  • PR title follows semantic commit guidelines
  • Search previous suggestions before making a new one, as yours may be a duplicate.
  • I acknowledge that all my contributions will be made under the project's license.

Notes: Forgot to split commits per change, apologizes.

Please create separate pull-requests. better for maintenance.

@Panquesito7
Copy link
Member Author

Do you mean, separate pull requests for:

  • Documentation.
  • Fixes.
  • Feat.

@kvedala
Copy link
Collaborator

kvedala commented Jun 25, 2020

Do you mean, separate pull requests for:

  • Documentation.
  • Fixes.
  • Feat.

separate pull-request for each file would be ideal. but no more than five related files per commit

The reason I could not split my previous merge #805 was because of the new addition of automated checks, compilation and other automation tools. Here, there is nothing stopping from being modular in creating atomic fixes and is the right way to go

@Panquesito7
Copy link
Member Author

I'll do as your request when I have time, thanks.

@kvedala
Copy link
Collaborator

kvedala commented Jun 26, 2020

I'll do as your request when I have time, thanks.

These are good fixes, but disorganized and hence an invitation for new issues.
Splitting them into coherent pulls would benefit the repo. 👍

@Panquesito7
Copy link
Member Author

@kvedala is it OK if I create a PR for each small folder (such as backtracking)?

@kvedala
Copy link
Collaborator

kvedala commented Jun 26, 2020

@kvedala is it OK if I create a PR for each small folder (such as backtracking)?

that would be better and start with one or two file changes only.

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