Skip to content

Latest commit

 

History

History
142 lines (88 loc) · 5.58 KB

CONTRIBUTING.md

File metadata and controls

142 lines (88 loc) · 5.58 KB
Raw

Contributing to CrewUp

Welcome to the CrewUp project! 🚀 Thank you for considering contributing to our project. We appreciate your effort and value your contributions. To ensure a smooth and collaborative experience for everyone involved, please take a moment to review the following guidelines.

Table of Contents

Development Environment Setup

To set up your development environment for contributing to CrewUp, please follow these steps:

  1. Fork the CrewUp repository: Click on the "Fork" button at the top right corner of the GitHub repository page to create a personal copy of the project in your own GitHub account.

  2. Clone the repository: Once you have forked the repository, clone it to your local machine using the following command in your terminal or command prompt:

    git clone https://github.com/TanmayAdithya/CrewUp.git

  3. Navigate to the project directory: Change your current directory to the cloned project directory:

    cd CrewUp

  4. Install dependencies: Install the project dependencies by running the following command:

    npm i

  5. Set up any required environment variables: If the project requires any environment variables, make sure to set them up according to the project's documentation.

  6. Start the development server: You can now start the development server by running the following command:

    npm start

    This will run the project locally, and you can access it in your web browser at http://localhost:5173.

  7. Make your changes: Start making your desired changes or additions to the codebase using your preferred code editor.

  8. Test your changes: Before submitting a pull request, make sure to test your changes thoroughly to ensure they work as expected and do not introduce any new issues.

Once you have completed these steps, you are ready to contribute to CrewUp! Open a pull request with your changes, and the project maintainers will review your contribution.

Thank you for your interest in contributing to CrewUp! We appreciate your support and look forward to collaborating with you to enhance our project.

How Can I Contribute?

Bug Reports

If you encounter a bug or any unexpected behavior while using CrewUp, please help us by opening an issue on our GitHub repository. When creating a bug report, please provide detailed information about the problem, including steps to reproduce it. This will help us understand and address the issue effectively.

Bug Report Template

## Bug Description

A clear and concise description of the bug.

## Steps to Reproduce

1. Step 1
2. Step 2
3. Step 3
   ...

## Expected Behavior

A clear and concise description of what you expected to happen.

## Actual Behavior

A clear and concise description of what actually happened.

## Screenshots or Error Messages

If applicable, add screenshots or error messages to help explain the issue.

## Environment (if relevant)

- Operating System: [e.g., Windows 10, macOS]
- Browser: [e.g., Chrome, Firefox]
- Version: [e.g., 92.0.4515.131]

## Additional Information

Add any other information about the problem here.

Feature Requests

We welcome your ideas and suggestions for improving CrewUp. If you have a feature request, please open an issue on our GitHub repository and provide a detailed description of the feature you would like to see. Explain why you believe the feature would be beneficial and provide any relevant examples or use cases.

Feature Request Template

## Feature Description

A clear and concise description of the feature you are requesting.

## Motivation

Explain why you believe this feature would be beneficial and how it addresses a specific need or problem.

## Proposed Solution

If you have any ideas on how this feature could be implemented or any specific requirements it should meet, please describe them here.

## Alternatives Considered

Have you considered any alternative solutions or workarounds? If so, please describe them here.

## Additional Information

Add any other information or context about the feature request here.

Pull Requests

If you'd like to contribute code to CrewUp, we encourage you to open a pull request. To do so, please follow these steps:

  1. Fork the CrewUp repository to your own GitHub account.
  2. Create a new branch for your changes.
  3. Implement your changes, adhering to the project's coding conventions and style guidelines.
  4. If applicable, include unit tests to ensure the integrity of your code.
  5. Document any changes or additions you've made, including updates to relevant documentation.
  6. Thoroughly test your changes to ensure they do not introduce any new issues.
  7. Open a pull request with a clear description of your changes. The project maintainers will review your pull request, provide feedback, and suggest any necessary modifications.

Code of Conduct

We have adopted a Code of Conduct to create a welcoming and inclusive environment for all contributors. By participating in this project, you agree to abide by the guidelines and expectations outlined in our Code of Conduct. Please familiarize yourself with its content to ensure a positive experience for everyone.

License

By contributing to CrewUp, you agree that your contributions will be licensed under the same License Name as the project itself.