search

TheAlgorithms / Solidity

Algorithms and data structures implemented in Solidity
GNU Lesser General Public License v2.1
332 stars 95 forks source link

[Doc] Create CONTRIBUTING.md #13

Closed mkubdev closed 2 years ago

mkubdev commented 2 years ago

Create Contributing guidelines file for the Solidity repos.

💡: Python's one is awesome !

akhil484 commented 2 years ago

Hey, I would like to contribute to this issue and can help in creating contributing guidelines. Can we discuss it a bit more?

mkubdev commented 2 years ago

Hi @akhil484 ! Sure 👋 We can discuss about smart contract testing strategy, and coding styles.

akhil484 commented 2 years ago

We can take Python's contributing.md that you mentioned above as a template and can discuss all areas we should include. How can we discuss it at length?

mkubdev commented 2 years ago

We can discuss here! Contributors can give their point of view.

You can add me in Discord: Kubdev#6277

akhil484 commented 2 years ago

Yes, I have sent you request on Discord. Let's discuss the coding style and what instructions should we provide to contributors.

mkubdev commented 2 years ago

Ok accepted. I think we can organize smart contracts by networks (Networks have somehow different business logic..) :

├── Ethereum
│   ├── Maths
│   ├── Common
│   ├── ...
├── Polygon
│   ├── Maths
│   ├── Common
│   │   ├── governance
│   │   ├── tokens
│   │   ├── misc
│   ├── Staking
│   ├── ...
├── ...
└── .gitignore

I'm waiting for the opinion of contributors. 🔈

shuklaritvik06 commented 2 years ago

Ok accepted. I think we can organize smart contracts by networks (Networks have somehow different business logic..) :

├── Ethereum
│   ├── Maths
│   ├── Common
│   ├── ...
├── Polygon
│   ├── Maths
│   ├── Common
│   │   ├── governance
│   │   ├── tokens
│   │   ├── misc
│   ├── Staking
│   ├── ...
├── ...
└── .gitignore

I'm waiting for the opinion of contributors. speaker

I agree!

mkubdev commented 2 years ago

Or we organize contracts by Solidity Concepts like:

├── Maths
│   ├── ...
├── Security
│   ├── ...
├── DAO
│   ├── ...
├── Governance
├── Staking

I don't know if it's a better approach instead of storing concepts by network since they can be implemented in every EVM networks.

akhil484 commented 2 years ago

I think organising smart contract by networks looks better.

KukretiShubham commented 2 years ago

Or we organize contracts by Solidity Concepts like:

├── Maths
│   ├── ...
├── Security
│   ├── ...
├── DAO
│   ├── ...
├── Governance
├── Staking

I don't know if it's a better approach instead of storing concepts by network since they can be implemented in every EVM networks.

I agree. Solidity is an EVM compatible language. So code execution will work exactly same on all networks. I like @mkubdev 's suggestion

mkubdev commented 2 years ago

So code execution will work exactly the same on all networks

That's what I thought! Thanks.

mkubdev commented 2 years ago

I close, solved by #17