About Embellish -
- Having a designed component in css? Want to flaunt it ? Do you want other people to use your component? Here we are. Contribute your component to Embellish.
- Embellish is a collection of awesome designed components or animations or components which can be added to any website to enhance the UI of your website.
🛠️ Technology Stack
📜 Instructions to follow while Contributing
- Make sure that with every design/ component should be added to a separate folder.
- Every folder should have its own
README.mdfile where instructions to setup environment should be there and a demo video in the form of a gif should be added. Refer to the README Template to make the README for the component you add. - Always update the table of contents in the parent folder where the new component is added.
- Whether you are adding an animation or a design component or any other code, make sure to include all the additional scripts and CDN's within the file/ folder itself and with addequate documentation as required. The code must be extremely simple to understand such that it is ready for immediate use in some project.
- Make sure to follow the Code of Conduct and be respectful towards others while contributing to the project.
How to contribute?
If you're not comfortable with command line, here are tutorials using GUI tools. If you don't have git on your machine, install it.
1. Fork this repository.
2. Clone your forked copy of the project.
git clone https://github.com/<your_name>/Embellish.git
3. Navigate to the project directory
cd Embellish
4. Add a reference(remote) to the original repository.
git remote add upstream https://github.com/siddhi-244/Embellish
5. Check the remotes for this repository.
git remote -v
6. 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
7. Create a new branch.
git checkout -b <your_branch_name>
8. Perform your desired changes to the code base.
9. Track your changes
git add .
10. Commit your changes .
git commit -m "Relevant message"
11. Push the committed changes in your feature branch to your remote repo.
git push -u origin <your_branch_name>
12. To create a pull request, click on compare and pull requests. Please ensure you compare your feature branch to the desired branch of the repository you are supposed to make a PR to.
13. Add appropriate title and description to your pull request explaining your changes and efforts done.
14. Click on Create Pull Request.
15 Voila! You have made a PR to the Embellish. Sit back patiently and relax while your PR is reviewed
Note -
- Please follow best code formatting and linting practices to assure good code quality. You should use tools such as Prettier or Eslint for thy purpose.
Project Maintainer & Admin
Siddhi Bhanushali