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.

Sign up for GitHub

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

Jump to bottom

Create a "common configuration" git repository which is auto-merged into SymbiFlow projects #51

Open
17 tasks
mithro opened this issue Apr 30, 2020 · 8 comments
Open
17 tasks

Create a "common configuration" git repository which is auto-merged into SymbiFlow projects #51

mithro opened this issue Apr 30, 2020 · 8 comments
Labels
enhancement help wanted project-ecosystem type-docs type-infra

Comments

@mithro
Copy link
Contributor

mithro commented Apr 30, 2020

We are increasingly getting files that should be consistent across all SymbiFlow repositories.

We should create a "common configuration" git repository which is auto-merged into the various SymbiFlow projects. It should probably include;

  • Stuff around style formatting including;
    • .editorconfig file
    • Copyright / license checking tools (plus Travis CI support for checking them)
    • Auto-formatting tools - clang-format, yapf, etc (plus Travis CI support for checking them)
  • Documentation around policies
    • Code of conduct
    • Contribution guide
    • Issue templates
    • Common replies to things like missing DCO and stuff
    • etc
  • Documentation building and publishing scripts
    • The Sphinx documentation generation
    • ReadTheDocs publishing
  • Useful infrastructure / CI scripts
    • Tools for handling the complexity of git submodules
    • Tools for getting and setting up environments using conda
    • etc

This could be related to https://github.com/SymbiFlow/.github or potentially replace it.
@mithro
Copy link
Contributor Author

mithro commented Apr 30, 2020

FYI - @daniellimws - You have been doing a lot of stuff around the documentation side of things, any thoughts on how to make that work?

@mithro
Copy link
Contributor Author

mithro commented Apr 30, 2020

This should probably use git subtrees and there be a bot to auto merge this into our repositories.

@mithro
Copy link
Contributor Author

mithro commented Apr 30, 2020

#50 is related.

@mithro
Copy link
Contributor Author

mithro commented Apr 30, 2020

#49 is also related.

@daniellimws
Copy link

Yup all the things here are very repetitive and SymbiFlow has so many repositories now. I've not used git subtrees before, will try it out.

@ryancj14
Copy link

@mithro This seems like a project we could take on here at BYU. We would start a reasonably new student on it. Our idea is that we will create a new repo that will serve as a container for the items on your checklist, and start our student on adding items to the repo. This project would continue throughout the summer, and anything that isn't done by our student could be added by other SymbiFlow contributors in the future. Our student would probably start by adding the .editorconfig file and some 'documentation around policies' items. Do you think this will be useful? Do you have any other thoughts/direction for us?

@ryancj14
Copy link

ryancj14 commented Jun 9, 2021 •
edited by unfurl-links bot

@mithro Based on this issue, we have a starting repository located at https://github.com/ryancj14/common-config that could accomplish the goals of this issue. Could you create a common-config repository in Symbiflow where we could put our initial work as a work in progress pull request? It seems like we could get a discussion going in that location for the things we plan to add.

GitHub
A preparatory repository for Symbiflow's common-config repo - ryancj14/common-config

@ryancj14
Copy link

ryancj14 commented Jun 30, 2021 •
edited by unfurl-links bot

@acomodi @mithro @kgugala The common-config repository has made some progress, and we think that it is the right time to move the repository over to Symbiflow ownership. Thanks to Tim for creating an issue there to help with the progress on that. You can find the repository here at https://github.com/ryancj14/common-config. We are ready to transfer ownership to you. Then we can continue to work on the repo through forks and pull requests. Do you think we should go ahead with that now?

GitHub
A preparatory repository for Symbiflow's common-config repo - ryancj14/common-config

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement help wanted project-ecosystem type-docs type-infra
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@mithro @daniellimws @ryancj14