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

Add information for contributors #641

Open
domenicoMuscill0 opened this issue Jun 20, 2023 · 0 comments
Open

Add information for contributors #641

domenicoMuscill0 opened this issue Jun 20, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@domenicoMuscill0
Copy link
Contributor

Would it be possible to update the github page section How to extend this library (or even just a file in this repository cited in the README) with some practical details about code writing style? I think it would be very useful to explain the workflow to follow in writing code or documentation (for example specifying to always create tests files for the code implemented, use relative imports and add the import to the init file) or even tips for helping the contributor follow the style of code of this library (e.g. using c_f.to_device(embeddings, device=device) instead of standard embeddings.to(device) function, running the tests launched by the .github/workflows folder locally before committing the code). In my opinion these changes could be very useful for not very experienced users that want to contribute anyway like me.

@KevinMusgrave KevinMusgrave added the documentation Improvements or additions to documentation label Jun 21, 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

2 participants