README.md

DSA

Welcome to DSA, one of the best ways to introduce the world of open-source contribution! Whether you're a beginner looking to take your first steps or an intermediate developer seeking to refine your skills, this repository is designed to make your journey into open-source development. This repo will provide with best hands-on understanding of open source contributions.

Our mission is to empower newcomers, providing them with a welcoming environment to learn and grow in the open-source community. This repo offers a curated collection of Java-based projects that are both fun to work on and highly educational. Through hands-on experience and guidance from our dedicated team of maintainers, you'll gain the skills and confidence to contribute to larger projects with ease. We can't wait to see what you'll bring to the open-source table – so dive in, explore, and start your open-source adventure today!

All your work details, including the path to your work, will be displayed on the Jekyll-based pages that are deployed using GitHub Pages. So, we expect quality work from you so that everyone can view your work with ease. This repo will not only introduce open-source contributions but also be one of the best platforms to showcase your skills and learn new skills from other projects. Thus, you'll be learning and teaching at the same time.

Contribution

Hey there, fellow developer !!!... I'm happy to see you are interested in contributing to this repo. As this is an open-source repo containing a collection of Java-based projects, you're always welcome to showcase your learning & implementation efforts. As the repo will be hosted using GitHub pages, you can write small documentation explaining about your project. As your work is being hosted live, we expect you to make some quality contributions so that others can learn and appreciate your work.

Important

Make sure to check the CONTRIBUTING.md to understand the rules, file structure and step-by-step guide for contribution.

• Step 1: Make sure you have required tools within you local machine *(like git, vs code, node.js and so on).

• Step 2: Now start by forking the repository.

• Step 3: Clone the forked repository to your local machine.

  #cloning the repo
  git clone https://github.com/<your-github-user-name>/DSA.git

• Step 4: Create a new branch to work on your contribution. use the following command:

  # create and check out to new branch
  git checkout -b <your-project-name>

• Step 5: Now go ahead and create your directory/folder with your project name with a proper naming convention and finish your project while maintaining a file structure & following other rules (checkout CONTRIBUTING.md for more details).

• Step 6: Make sure you commit every change while working on your project parallelly. Using the following command:

  # tracking or staging the changes
  git add .
  
  # commiting the changes
  git commit -m "<related-short-message>

  [!IMPORTANT] Make sure to commit each change with a proper description

• Step 7: After committing all the changes and completion of your work. push your commit to your forked repo, using the following commands:

  # push your commit to the origin repo
  git push origin <your-project-name>

• Step 8: Now, create a pull request to the original repo. Learn about Pull requests

• Step 9: After making PR, check for the linting check to pass. If the linting checks fail, find and fix the issue with the help of the eslint result in workflow.

• Step 10: If the liniting checks passed, then wait for the maintainer to check and merge the pull request.

When the maintainer merges your PR, you have successfully made your (probably first) open-source contribution to showcase your learning and provide a reference to a complete newbie. Everybody can see your work and make use of it. Good job, mate !!...

Contributors

Thank you for your valuable contribution to this repo. Your work will not be forgotten...