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

Missing Contribution.md file #433

Open
yaarAdarsh opened this issue Oct 20, 2024 · 3 comments
Open

Missing Contribution.md file #433

yaarAdarsh opened this issue Oct 20, 2024 · 3 comments

Comments

@yaarAdarsh
Copy link

There is a need to add a contribution.md file. So that anyone who wants to contribute have an idea of what steps to follow for contribution.
I want to work on this issue. Please assign me this task.

@michaelfeil
Copy link
Owner

Please don't make it a contribution.md, but contribute a /docs/contribution.md.

There is some note in the Pull-Request.md

# cd to libary of contribution e.g. infinity_emb 
cd libs/infinity_emb 
poetry install --extras all
# cd to libary of contribution e.g. infinity_emb 
cd libs/infinity_emb 
# run tests, auto-generate files, run liniting, formatting
make precommit 

This task entails:

  • Creating a /docs/docs/contribution.md
  • Syncing it with the Pull request template.md in the /.github folder
  • Keeping both as slim as possible. If possible, slim down also the Pull request template.md

@yaarAdarsh
Copy link
Author

hi @michaelfeil , thanks for your reply.

According to the task you assigned me there is already a contribution.md file present on that path i.e. /docs/docs/contribution.md.

So how am I supposed to contribute on it.

Also, please describe what you mean by keeping slim as possible .

Waiting for your reply . Thanks.

@michaelfeil
Copy link
Owner

@yaarAdarsh Thanks for your response! I think the task is clear.

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