β‘ A curated collection of npm packages for its various use cases. π
MIT License
This repository contains/will contains various existing npm modules and user defined modules that you can tweak according to your needs and use them in your projects. Our noble aim is to craft the grandest repository of npm packages, complete with proper documentation. So, What are you waiting for? π€
contributing guidelines
if you're interested in helping!Are we missing any of your favorite modules, which you think you can add to itβ We invite you to contribute to this project and make it better. To start contributing, follow the below guidelines.
1. Fork this repository.
2. Clone your forked copy of the project.
git clone https://github.com/<your_user_name>/npmBox.git
3. Navigate to the project directory π .
cd npmBox
4. Add a reference(remote) to the original repository.
git remote add upstream https://github.com/R-Ayush777/npmBox
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 master
7. Create a new branch.
git checkout -b <your_branch_name>
8. Perform your desired changes to the code base.
Note: Before making any modifications, be sure to install all essential packages with the npm install <package name>
command.
If You adding new package
cd npm_Modules
> for existing npm packages and to user_Modules <cd user_Modules
> for user defined packages<name of package>
<name of package>.js
. if it contains multiple files then main file should be named as above.
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
.
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 npmBox π₯ . Wait for your submission to be accepted and your PR to be merged.
16. Congratulations! You've made your first contribution! π
For further details, click on CONTRIBUTING.md
In order to make a hassle-free environment, I implore you all (while contributing) to follow the instructions mentioned above!
Happy Submissions π
To maintain a safe and inclusive space for everyone to learn and grow, contributors are advised to follow the Code of Conduct.
Thanks goes to these wonderful people