Skip to content

Latest commit

 

History

History
79 lines (46 loc) · 4.07 KB

CONTRIBUTING.md

File metadata and controls

79 lines (46 loc) · 4.07 KB
Raw

Contributing to Crusyt

Thank you for considering contributing to Crusyt! Crusyt is a web application built using the Express MVC framework that provides sentiment analysis for social media posts on platforms like Facebook, Twitter, Reddit, and more. The primary goal of Crusyt is to help users gauge the overall buzz and sentiment surrounding a business or product in the market.

We appreciate your interest in helping us improve Crusyt. Whether you're a developer, designer, or just a user with feedback, your contributions are valuable to us.

How Can You Contribute?

There are several ways you can contribute to Crusyt:

  1. Code Contributions: If you are a developer and want to contribute to the codebase, we welcome your pull requests. Whether you want to fix a bug, add a feature, or improve the documentation, your code contributions are highly appreciated.

  2. CSS Expertise: Crusyt could use help in improving its CSS to make the web application more visually appealing and user-friendly. If you have expertise in CSS or web design, your assistance in enhancing the user interface would be invaluable.

  3. Issue Reporting: If you encounter any issues, bugs, or have suggestions for improvements, please open an issue on our GitHub repository. Be sure to provide as much detail as possible to help us understand the problem.

  4. Documentation: Crusyt's documentation can always use improvement. If you find any errors or want to enhance the documentation, please submit a pull request.

  5. NLP Expertise: Crusyt relies heavily on Natural Language Processing (NLP) for sentiment analysis. If you have expertise in NLP and Node.js, your insights and assistance in improving our NLP capabilities would be invaluable.

Getting Started

If you're interested in contributing code to Crusyt, here are the steps to get started:

  1. Fork the Repository: Start by forking the Crusyt repository to your GitHub account.

  2. Clone the Repository: Clone the forked repository to your local development environment.

    git clone https://github.com/your-username/crusyt.git

  3. Install Dependencies: Navigate to the project directory and install the required dependencies.

    cd crusyt
npm install

  4. Create a Branch: Create a new branch for your contribution.

    git checkout -b feature/your-feature-name

  5. Make Changes: Make your desired changes or additions to the codebase.

  6. Test Your Changes: Ensure that your changes do not introduce any new issues and that they adhere to our coding standards.

  7. Commit Your Changes: Commit your changes with a clear and concise commit message.

    git commit -m "Add feature/fix for XYZ"

  8. Push to Your Fork: Push your changes to your forked repository.

    git push origin feature/your-feature-name

  9. Create a Pull Request: Finally, create a pull request from your forked repository to the main Crusyt repository. Be sure to provide a detailed description of your changes.

CSS and Design

If you have expertise in CSS or web design, we would greatly appreciate your help in improving the visual aspects of Crusyt. Please feel free to reference the flow_design.png file to get an idea of how the web application should work and look.

Code of Conduct

Please note that we have a Code of Conduct in place. We expect all contributors to follow these guidelines to ensure a positive and inclusive community.

Contact

If you have any questions, need clarification, or want to discuss your contributions further, feel free to reach out to us via:

Thank you for your interest in contributing to Crusyt. We look forward to working with you!