my-project-public

repository

loading code, commits, and activity

repositories

loading repo index

my-project-public — gitlawb

#1	# Contributing to embedchain
#2
#3	Let us make contribution easy, collaborative and fun.
#4
#5	## Submit your Contribution through PR
#6
#7	To make a contribution, follow these steps:
#8
#9	1. Fork and clone this repository
#10	2. Do the changes on your fork with dedicated feature branch `feature/f1`
#11	3. If you modified the code (new feature or bug-fix), please add tests for it
#12	4. Include proper documentation / docstring and examples to run the feature
#13	5. Check the linting
#14	6. Ensure that all tests pass
#15	7. Submit a pull request
#16
#17	For more details about pull requests, please read [GitHub's guides](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).
#18
#19
#20	### 📦 Package manager
#21
#22	We use `poetry` as our package manager. You can install poetry by following the instructions [here](https://python-poetry.org/docs/#installation).
#23
#24	Please DO NOT use pip or conda to install the dependencies. Instead, use poetry:
#25
#26	```bash
#27	make install_all
#28
#29	#activate
#30
#31	poetry shell
#32	```
#33
#34	### 📌 Pre-commit
#35
#36	To ensure our standards, make sure to install pre-commit before starting to contribute.
#37
#38	```bash
#39	pre-commit install
#40	```
#41
#42	### 🧹 Linting
#43
#44	We use `ruff` to lint our code. You can run the linter by running the following command:
#45
#46	```bash
#47	make lint
#48	```
#49
#50	Make sure that the linter does not report any errors or warnings before submitting a pull request.
#51
#52	### Code Formatting with `black`
#53
#54	We use `black` to reformat the code by running the following command:
#55
#56	```bash
#57	make format
#58	```
#59
#60	### 🧪 Testing
#61
#62	We use `pytest` to test our code. You can run the tests by running the following command:
#63
#64	```bash
#65	poetry run pytest
#66	```
#67
#68
#69	Several packages have been removed from Poetry to make the package lighter. Therefore, it is recommended to run `make install_all` to install the remaining packages and ensure all tests pass.
#70
#71
#72	Make sure that all tests pass before submitting a pull request.
#73
#74	## 🚀 Release Process
#75
#76	At the moment, the release process is manual. We try to make frequent releases. Usually, we release a new version when we have a new feature or bugfix. A developer with admin rights to the repository will create a new release on GitHub, and then publish the new version to PyPI.
#77

z6Mkq5mY3JWtxoxUobWcfNHm7AkRubgSWEZTkBVqZXJviFZ5/my-project-public