infinity icon indicating copy to clipboard operation
infinity copied to clipboard

Missing Contribution.md file

Open yaarAdarsh opened this issue 1 year ago • 3 comments

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.

yaarAdarsh avatar Oct 20 '24 04:10 yaarAdarsh

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

michaelfeil avatar Oct 29 '24 00:10 michaelfeil

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.

yaarAdarsh avatar Oct 29 '24 07:10 yaarAdarsh

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

michaelfeil avatar Oct 29 '24 14:10 michaelfeil