Cheatsheets are very handy tool for developers. Because it is not possible for us to remember all the commands or functions of a library at once. In that case, if we make a list of such commands or function does such a thing, then very easily when someone wants to work later, they can find everything they need just by looking at that list. We can divide our entire knowledge into different categories and list only the actual functionality very briefly. In which later a developer will find what he wants with just a quick glance. Similar cheatsheets are available here. But our aim is to make cheat sheet in full Bengali. in future if you need we try to make the cheatsheet in english also.
This project is completely GitHub based. This is where all our cheatsheets are organized as json files inside a directory called data. Our main application will display the data from here. We currently support two formats of cheatsheets.
- Format with code and description(See demo here)
- Code Only(See demo here)
- mix (see demo here)
Any new formats will be added in future if needed. If you want from can create an issue to create a new format_
(How to Contribute)
Since we are dealing with json files here, many may not be familiar with json. For that purpose we also put a draft directory inside the data directory. If you can't contribute with a json file, you can push your cheatsheet in any format to the draft folder with a clean title. At the same time, if you want, you can take a draft from the draft folder and convert it to json format and push it inside the original data directory. So this is how you can contribute to this project in 4 ways if you want:
- You can push cheatsheets on any topic in Bengali json format by maintaining our format in any way.
- You can push cheat sheet draft on any topic in Bengali in any format.
- Can convert other's drafts to our desired json format and push.
There will be a few main contributors who will do the work of showing a cheatsheet on the original website. In that case those who will contribute more in our list of contributors or if anyone seems responsible enough then he will be added to the list of admins of the whole organization.
Contributing Guidelines📝
You are welcome to contribute to this project. To start contributing, follow the below guidelines:
- Fork this repository.
- Clone your forked copy of the project. git clone https://github.com/<your_user_name>/devsonket.github.io.git
- Navigate to the project directory 📁 cd devsonket
- Add a reference(remote) to the original repository. git remote add upstream (https://github.com/devsonket/devsonket.github.io.git)
- Check the remotes for this repository. git remote -v
- Always take a pull from the upstream repository to your master branch to keep it at par with the main project(updated repository). git pull upstream main
- Create a new branch. git checkout -b <your_branch_name>
- Perform your desired changes to the code base.
- Track your changes ✔️. git add .
- Commit your changes. git commit -m "Relevant message"
- Push the committed changes in your feature branch to your remote repo. git push -u origin <your_branch_name>
- To create a pull request, click on compare and pull requests.
- Add an appropriate title and description to your pull request explaining your changes and efforts.
- Click on Create Pull Request.
- Woohoo!🥳 You have made a PR to the devsonket. Wait for your submission to be accepted and your PR to be merged. You made it! 🎊
If you don't know what topic to cheatsheet on, you can get ideas from our project board. Here Basically we keep updated list of important cheatsheets that will be useful for everyone.
Yes, our aim here is to build a big cheat sheet repository in Bengal. It is a completely independent and open source GitHub organization. It is not privately owned. I will reach our goal together with all of you.
We have a Facebook group. You can join there by clicking this link. If you need any help, have any suggestion or discuss anything openly with all of us there.
If you also want to sponsor Dev Signal in any way, or organize an event for Dev Signal please let us know.