Skip to content

Latest commit

 

History

History
56 lines (42 loc) · 2.93 KB

Contributing.md

File metadata and controls

56 lines (42 loc) · 2.93 KB
Raw

Contributing to Smathchat

Thank you for your interest in contributing to Smathchat! This document will guide you on how to contribute to the project and make your contributions valuable. First of all, I want to share that this is a makeover for my old project of 2 years. I want to make it better and deploy on render or Microsoft Azure so that students can use it.

Technologies Used

Smathchat is built using the following languagues:

  • HTML
  • CSS
  • JavaScript
  • Python

Make sure you have a good understanding of these technologies before contributing. Familiarize yourself with the project structure and codebase to effectively contribute.

Getting Started

To contribute to Smathchat, follow these steps:

  1. Fork the repository to your GitHub account.
  2. Clone the forked repository to your local machine.
  3. Set up the development environment by installing any necessary dependencies.
  4. Make your changes or additions to the codebase.
  5. Test your changes locally to ensure they work as intended.
  6. Commit your changes and push them to your forked repository.
  7. Create a pull request (PR) from your forked repository to the main repository.

Coding Guidelines

When contributing to Smathchat, it's important to follow the coding guidelines to maintain consistency and readability. Here are some guidelines to keep in mind:

  • Use meaningful and descriptive variable and function names.
  • Comment your code where necessary to explain the functionality and intent.
  • Follow the existing code formatting and indentation style.
  • Write concise and modular code that adheres to best practices.

Submitting a Pull Request (PR)

To submit your contribution, create a pull request from your forked repository. Follow these steps:

  1. Ensure that your forked repository is up to date with the latest changes from the main repository.
  2. Create a new branch for your changes, with a descriptive name.
  3. Make your changes, commit them with clear and concise messages.
  4. Push your changes to the branch on your forked repository.
  5. Go to the main repository and create a new pull request.
  6. Provide a descriptive title and detailed description of your changes in the pull request.
  7. Submit the pull request and wait for the project maintainers to review your contribution.

Feedback and Discussions

If you have any questions, need clarification, or want to discuss ideas related to SameerSweetyFolio, you can:

  • Open an issue on the GitHub repository to discuss specific topics or report bugs.
  • Leave comments on individual lines or sections of code using GitHub's inline commenting feature.
  • Reach out to SameerSweety directly through the provided contact information in the portfolio.

Conclusion

By following these guidelines, you can contribute to SameerSweetyFolio and help make it even better. Your contributions are valuable and greatly appreciated. Thank you for being a part of this project!

Let's make Smathchat an exceptional showcase of skills and projects together!