Thank you for considering contributing to the GlassyUI project! We welcome contributions from the community and are grateful for your help in making this project better.
Please read and adhere to our Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to the project maintainers.
- Code of Conduct
- Need Help With Basics
- Project Structure
- How to Contribute
- Setting Up Your Development Environment
- Style Guides
- Good Coding Practices
- Help And Support
If you're new to Git and GitHub, no worries! Here are some useful resources:
- Forking a Repository
- Cloning a Repository
- How to Create a Pull Request
- Getting Started with Git and GitHub
- Learn GitHub from Scratch
GLASSYUI-COMPONENTS/
├── .github/ # GitHub-related configurations such as workflows, issue templates, etc
│
├── .husky/ # Some pre-committed files
│
├── Images/ # Contains images related to the project
│
├── public/ # Some core components of the project
│
├── src/ # All the typescripts and react related files
│
├── .dockerignore
│
├── .eslintignore
│
├── .gitignore
│
├── .prettierignore
│
├── .prettierrc
│
├── CODE_OF_CONDUCT.md # Some rules for contributors
├──
├── CONTRIBUTING.md # Instructions for the contributors
├──
├── docker-compose.yml
├──
├── Dockerfile
├──
├── eslint.config.mjs
├──
├── git
├──
├── package-lock.json
├──
├── package.json
├──
├── postcss.config.js
├──
├── README.md # Some instructions related to the contributions
├──
├── tailwind.config.js
├──
├── tsconfig.jsonWhen creating a new issue, please provide the following information:
- Title: A brief description of the issue.
- Description: A detailed description of the issue or enhancement.
- Steps to Reproduce: For bugs, provide steps to reproduce the issue.
- Screenshots: Include any relevant screenshots.
-
Star this repository Click on the top right corner marked as Stars at last.
-
Fork this repository Click on the top right corner marked as Fork at second last.
-
Clone the forked repository
git clone https://github.com/<your-github-username>/GlassyUI-Components.git- Navigate to the project directory
cd GlassyUI-Components- Create a new branch
git checkout -b <your_branch_name>- To make changes
git add .- Now to commit
git commit -m "add comment according to your changes or addition of features inside this"- Push your local commits to the remote repository
git push -u origin <your_branch_name>-
Create a Pull Request
-
Congratulations! 🎉 you've made your contribution
-
Open GitHub Desktop: Launch GitHub Desktop and log in to your GitHub account if you haven't already.
-
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.
- 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.
- Make Changes:
- Make your changes to the code or files in the repository using your preferred code editor.
- 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.
- 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.
- 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.
- 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.
- 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.
- Submit a Pull Request: Go to the repository on GitHub and click the "New pull request" button.
- Provide a Description: Include a detailed description of your changes and link to the issue being addressed.
- Wait for Review: One of the maintainers will review your pull request and provide feedback.
If you find a bug, please report it by creating a new issue. Provide as much information as possible, including steps to reproduce the bug and any relevant screenshots.
We welcome suggestions for new features and enhancements. Please open an issue to discuss your idea before implementing it to ensure it aligns with the project's goals.
- Look through the open issues for tasks labeled with "good first issue" or "enhancement."
- Comment on the issue to let others know you are working on it.
- Fork the repository and create a new branch for your work.
- Implement your changes following the project's coding standards and guidelines.
- Submit a pull request for review.
-
Fork the Repository: Click the "Fork" button at the top right of the repository page.
-
Clone Your Fork:
git clone https://github.com/your-username/GlassyUI-Components.git
cd GlassyUI-Components -
Install Dependencies:
npm install
-
Start the Development Server:
npm start
- Use the present tense ("Add feature" not "Added feature").
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
- Limit the first line to 72 characters or less.
- Reference issues and pull requests liberally.
- Follow the Airbnb JavaScript Style Guide.
- Use ES6 syntax where applicable.
- Ensure your code passes all linting and formatting checks.
- Use SCSS for styling.
- Follow the BEM methodology for class naming.
- Keep styles modular and reusable.
- Use functional components with hooks where possible.
- Ensure components are modular and reusable.
- Write unit tests for all components using a testing library such as Jest.
-
Follow the Project's Code Style
- Maintain consistency with the existing code style (indentation, spacing, comments).
- Use meaningful and descriptive names for variables, functions, and classes.
- Keep functions short and focused on a single task.
- Avoid hardcoding values; instead, use constants or configuration files when possible.
-
Write Clear and Concise Comments
- Use comments to explain why you did something, not just what you did.
- Avoid unnecessary comments that state the obvious.
- Document complex logic and functions with brief explanations to help others understand your thought -process.
-
Keep Code DRY (Don't Repeat Yourself)
- Avoid duplicating code. Reuse functions, methods, and components whenever possible.
- If you find yourself copying and pasting code, consider creating a new function or component.
-
Write Tests
- Write unit tests for your functions and components.
- Ensure your tests cover both expected outcomes and edge cases.
- Run tests locally before making a pull request to make sure your changes don’t introduce new bugs.
-
Code Reviews and Feedback
- Be open to receiving constructive feedback from other contributors.
- Conduct code reviews for others and provide meaningful suggestions to improve the code.
- Always refactor your code based on feedback to meet the project's standards.
- Admin Github Profile:- Jaishree Singh
- Contact :- Email
We truly appreciate your time and effort to help improve our project. Feel free to reach out if you have any questions or need guidance. Happy coding! 🚀