Skip to content

Setup Git hooks similar to main development repository #3

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

Open
kgryte opened this issue Oct 31, 2023 · 6 comments
Open

Setup Git hooks similar to main development repository #3

kgryte opened this issue Oct 31, 2023 · 6 comments

Comments

@kgryte
Copy link
Member

kgryte commented Oct 31, 2023

Prior to committing and pushing, we should run lint processes and, where applicable, run tests, examples, and benchmarks.

Similarly, we should check whether the package.json has changed in order to determine whether to reinstall node modules dependencies.

@adityacodes30
Copy link

adityacodes30 commented Mar 9, 2024

I would like to take this up !

@kgryte
Copy link
Member Author

kgryte commented Mar 10, 2024

@adityacodes30 Thanks for volunteering. This task should help provide an intro to the repo, at least from a build perspective. Note, however, that the hook commands will not be 1:1 with the main project and will need to be tailored accordingly.

@adityacodes30
Copy link

adityacodes30 commented Mar 10, 2024

Understood, will try to imitate the functionality while tailoring it to the structure and implementation of this repo. Since the documentation and everything is in a nascent stage, I will ask the maintainers if i find any ambiguity. Could you please assign it to me as well. Thanks

@kgryte
Copy link
Member Author

kgryte commented Mar 10, 2024

Assigned.

@adityacodes30
Copy link

I have been inspecting this issue and have been taking the main repo as reference to the rules and conventions of the directory structure and implementation. I think i now have a fair idea of the structure and requirements.

For me to move ahead with this i will need to create the required make files , some folders such as tools, etc and more. I want to ask if this is the correct approach to take for this project and one i should go ahead with?

@kgryte
Copy link
Member Author

kgryte commented Mar 16, 2024

For the make files, I suggest seeing how far you can get adding recipes to the existing Makefile in the root project directory.

For linting tools, I'd create a tools directory in the root project directory and add them there. We can iterate on organization once you have something working.

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

No branches or pull requests

2 participants