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

Software engineering practices #238

Closed
tianyin opened this issue Jul 16, 2023 · 0 comments
Closed

Software engineering practices #238

tianyin opened this issue Jul 16, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@tianyin
Copy link
Member

tianyin commented Jul 16, 2023

@Spedoske @tylergu Given that we are planning to open the project soon (e.g., for AE) and later even turn the project into an open-source endeavor, I think it's time to enforce some good software engineering efforts.

I love the PR practice @Spedoske started -- basically we should not directly push to the master branch, but trying to open PRs and merging PRs. It also enforces the regression tests to be run.

Moreover, I think we really should start to submit small, incremental PRs instead of gigantic PRs which is hard to review and merge. Please try to break your big PR into a number of small PRs and submit them.

Third, when merging PRs, please choose to "Squash the commits into one commit" -- basically each PR should be merged with only 1 commit, instead of multiple ones. This could make the commit history much cleaner and easy to maintain.

Lastly, let's follow the Action Plan practice and write and comment on action plan in time.

@tianyin tianyin added the documentation Improvements or additions to documentation label Jul 16, 2023
@tianyin tianyin pinned this issue Jul 16, 2023
@tianyin tianyin closed this as completed Jul 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants