Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[enhacement] create testing setup for the local_environment #56

Open
Titleshwar opened this issue Oct 9, 2024 · 0 comments
Open

[enhacement] create testing setup for the local_environment #56

Titleshwar opened this issue Oct 9, 2024 · 0 comments
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@Titleshwar
Copy link
Contributor

Titleshwar commented Oct 9, 2024

🎉 Contribution Guidelines Should Consist of:


🛠️ Repository Setup

To start contributing, you need to set up the project on your local machine. Follow these steps:

  1. Fork the repository.
  2. Clone your fork to your local environment.
  3. Install the necessary dependencies.

🌿 Branching Guidelines

  • Always create a new branch for your changes.
  • Use a descriptive branch name like feature/add-new-feature or fix/issue-description.
    This helps keep the main branch clean and avoids conflicts.

✅ Testing Changes Locally

  • Test thoroughly before making a pull request (PR).
  • Run the project locally and make sure your changes do not break any existing functionality.
  • Run any available tests to ensure code reliability.
  • Don't submit untested code.

🧹 Code Quality

  • Ensure your code is clean and follows the project’s coding style.
  • Remove unnecessary comments and debug logs.
  • Use meaningful variable and function names.
  • Check for readability and make sure other contributors can easily understand your code.

🔄 Creating Pull Requests

  • Once you're confident with your changes, create a pull request.
  • Include a clear title and description of the changes you made.
  • Link any relevant issues or feature requests in your PR.
  • Be sure to explain why your changes are necessary or beneficial.

🐛 Raising Issues

When reporting an issue or proposing a feature, please:

  1. Provide a descriptive title.
  2. Include detailed information on how to reproduce the bug or what the feature would do.
  3. Mention relevant environments (e.g., browser, OS, versions).
  4. Add screenshots or logs if necessary to clarify the issue.

⚙️ How to Test the Repo Locally Before Submitting a Pull Request

  1. Run the development server after making your changes to see how the project behaves locally.
  2. Check for errors in the console and make sure all features work as expected.
  3. If the project includes unit or integration tests, make sure to run them:
    npm test
@aabhinavg1 aabhinavg1 added enhancement New feature or request good first issue Good for newcomers labels Oct 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants