Skip to content

Latest commit

 

History

History
316 lines (235 loc) · 16.6 KB

CONTRIBUTING.md

File metadata and controls

316 lines (235 loc) · 16.6 KB
Raw

Party Popper Welcome! Thanks for your interest in contributing to DevDisplay Love Letter


Connect with DevDisplay Organization Raising Hands

Discord Logo Discord Logo WhatsApp Logo Linkedin Logo Twitter Logo Instagram Logo
GitHub Discord WA Linkedin Twitter Insta.

Rocket Let's Start, But First Glowing Star Star The DevDisplay Repository! Rocket

Starring the repository is a mandatory step for all contributors and the first priority in contributing to DevDisplay.
Man Technologist

Man Juggling Light Skin Tone Add Your Profile On DevDisplay Man Juggling Light Skin Tone

Click Here For Add Your Profile on DevDisplay and Start your Contribution

Steps to Add Your ProfileBackhand Index Pointing Down

  1. Fork the repository: To create a copy of the repository in your GitHub account, click on the "Fork" button in the top right corner of the project repository page.

  2. Navigate to the public/data folder in your project directory.

  3. Create a new JSON file named your_github_username.json (replace your_github_username with your actual GitHub username). Open the file you just created.

  4. Add the following JSON object, replacing the placeholder values with your own details:

    {
  "name": "Your Name",
  "location": "Your Location",
  "bio": "Your Bio should be 20-30 words not more than that",
  "avatar": "https://github.com/your-github-username.png",
  "portfolio": "Your Portfolio URL or Github URL",
  "skills": ["Your Skill 1", "Your Skill 2", "..."],
  "social": {
    "GitHub": "https://github.com/your-github-username",
    "Twitter": "https://twitter.com/your-twitter-username",
    "LinkedIn": "https://www.linkedin.com/in/your-linkedin-username",
    "Instagram": "https://www.instagram.com/your-instgram-username",
    "Email": "your-email-id"
  }
}

  5. Save the your_github_username.json file.

  6. Navigate to the src folder in your project directory. Open the ProfilesList.json file.

  7. Add your JSON filename (your_github_username.json) to the array of filenames in the ProfileList.json file, like this:

    ["filename1.json", "filename2.json", "filename3.json", "your_github_username.json"]

  8. Save the ProfileLists.json file.

  9. Contribute Follow this 👇🏻:

  10. Wait for review and merge: Wait for the project maintainers to review and merge your changes.

Once your changes are merged Party Popper Your profile will be displayed on the project's website and you will receive a Dev Pioneer Badge via email also a personalized appreciation post will be shared on LinkedIn and Twitter through DevDisplay's official social media handles.

Rocket Top Prioritized Features for Contribution - After Profile Setup Rocket

Below is a list of feature requests that need your focus. Please prioritize these before creating or working on other issues. Pick a feature request from the list above. Visit the linked issue details for a detailed description and requirements. Fork the repository, make your changes, and submit a pull request referencing the issue.

Click on any feature below to view its issue details and start contributing.

Feature Page Link Issue Details
Opportunities Features View Page View Issue
Discussion Features View Page View Issue
Idea Submission Features View Page View Issue
Portfolio Ideas Features View Page View Issue
Project Showcase Features View Page View Issue
Portfolio Building Features View Page View Issue
Resume Building Features View Page View Issue
Tech Resources Features View Page View Issue

Man Raising Hand Light Skin Tone Need Help Man Raising Hand Light Skin Tone

Click Here For Need Help With The Basics? 🤔

If you're new to Git and GitHub, no worries! Here are some useful resources:


Click Here To View The Project Structure 📂 
DEVDISPLAY/
├── .github/                  # GitHub-related configurations such as workflows, issue templates, etc
│
├── .husky/                   # Some pre-committed files
│
├── dist/                     # Stylesheet file is included here
│
├── public/                   # Contains images and the index.html file
│
├── src/                      # Contains javascript files and stylesheet files
│
├── .gitignore
│
├── .prettierrc.json
│
├── CODE_OF_CONDUCT.md        # Some rules for the contributors
│
├── CONTRIBUTING.md           # Instructions for the contributors
│
├── LICENSE                   # A permission to do something
│
├── package-lock.json
├──
├── package.json
├──
├── README.md                 # Some instructions related to the contributions
├──
├── tailwind.config.js

Click Here For First Pull Request ✨

  1. Star this repository Click on the top right corner marked as Stars at last.

  2. Fork this repository Click on the top right corner marked as Fork at second last.

  3. Clone the forked repository

git clone https://github.com/<your-github-username>/DevDisplay.git
  1. Navigate to the project directory
cd DevDisplay
  1. Create a new branch
git checkout -b <your_branch_name>
  1. To make changes
git add .
  1. Now to commit
git commit -m "add comment according to your changes or addition of features inside this"
  1. Push your local commits to the remote repository
git push -u origin <your_branch_name>

  1. Create a Pull Request

  2. Congratulations! 🎉 you've made your contribution


Click Here For Installing The Node Packages 📩
  1. Install dependencies

Time to gather our supplies! Navigate to the project folder in your terminal and install the dependencies with these magical incantations:

npm install
  1. Launch the Application

Ready to unveil your creation? Use this command to start the application:

npm start
  1. Test Your Changes

Before you reveal your wizardry, ensure everything works like a charm. Run the tests with this enchantment:

npm test

Click Here For Contribute using GitHub Desktop 🖥️

  1. Open GitHub Desktop: Launch GitHub Desktop and log in to your GitHub account if you haven't already.

  2. Clone the Repository:

  • If you haven't cloned the project repository yet, you can do so by clicking on the "File" menu and selecting "Clone Repository."

  • Choose the project repository from the list of repositories on GitHub and clone it to your local machine.

    3.Switch to the Correct Branch:

  • Ensure you are on the branch that you want to submit a pull request for.

  • If you need to switch branches, you can do so by clicking on the "Current Branch" dropdown menu and selecting the desired branch.

  1. Make Changes:
  • Make your changes to the code or files in the repository using your preferred code editor.
  1. Commit Changes:
  • In GitHub Desktop, you'll see a list of the files you've changed. Check the box next to each file you want to include in the commit.
  • Enter a summary and description for your changes in the "Summary" and "Description" fields, respectively. Click the "Commit to " button to commit your changes to the local branch.
  1. Push Changes to GitHub:
  • After committing your changes, click the "Push origin" button in the top right corner of GitHub Desktop to push your changes to your forked repository on GitHub.
  1. Create a Pull Request:
  • Go to the GitHub website and navigate to your fork of the project repository.
  • You should see a button to "Compare & pull request" between your fork and the original repository. Click on it.
  1. Review and Submit:
  • On the pull request page, review your changes and add any additional information, such as a title and description, that you want to include with your pull request.
  • Once you're satisfied, click the "Create pull request" button to submit your pull request.
  1. Wait for Review: Your pull request will now be available for review by the project maintainers. They may provide feedback or ask for changes before merging your pull request into the main branch of the project repository.

Pull Request Process Rocket

When submitting a pull request, please adhere to the following:

  1. Self-review your code before submission. 😀
  2. Include a detailed description of the functionality you’ve added or modified.
  3. Comment your code, especially in complex sections, to aid understanding.
  4. Add relevant screenshots to assist in the review process.
  5. Submit your PR using the provided template and hang tight; we'll review it as soon as possible! 🚀

Issue Report Process Comet

To report an issue, follow these steps:

  1. Navigate to the project's issues section :- Issues
  2. Please kindly choose the appropriate template according to your issue.
  3. Provide a clear and concise description of the issue.
  4. Wait until someone looks into your report.
  5. Begin working on the issue only after you have been assigned to it. 🚀

Clapping Hands We appreciate your support Love Letter Thank you for contributing Clapping Hands

Love Letter