Skip to content

Latest commit

 

History

History
60 lines (37 loc) · 3.43 KB

CONTRIBUTION.md

File metadata and controls

60 lines (37 loc) · 3.43 KB
Raw

Contributing Guidelines

Thank you for considering contributing to our project! We welcome contributions from everyone. To maintain a positive and collaborative environment, please follow these guidelines:

Creating Issues:

  1. Search Existing Issues: Before creating a new issue, please search existing issues to see if the topic has already been discussed or reported.

  2. Clear and Descriptive Title: Provide a clear and descriptive title for your issue, summarizing the problem or enhancement.

  3. Detailed Description: Provide a detailed description of the issue, including steps to reproduce (if applicable), expected behavior, and actual behavior.

  4. Use Labels: Use appropriate labels to categorize your issue (e.g., bug, enhancement, documentation, etc.).

Development Setup:

  1. Fork and clone the Repository
  2. Pull latest changes from the main repository if it has diverged
  3. Create a virtual environment for the project
  4. Install dependencies using pip install -r requirements.txt
  5. Install pre-commit hook using pre-commit install
  6. Run tests using pytest tests/test_file_name.py or specific test name like pytest tests/test_file_name.py::test_function_name
  7. Ensure the features is passing the acceptance criteria by pytest test_results.py or python test_results.py
  8. Do not push changes without the tests and coverage passing
  9. Commit your changes with proper commit messages in imperative form like Add my best feature, Fix issues casusing whatever, Update docs etc: Good reference here
  10. Make changes and push to your forked repository
  11. Create PR to the forked repository as mentioned below

Pull Requests (PRs):

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

  2. Clone the Repository: Clone the forked repository to your local machine using the git clone command.

  3. Create a Branch: Create a new branch for your contribution. Use descriptive and concise names for your branches. Avoid using special characters and whitespace.

  4. Make Changes: Make your desired changes to the codebase.

  5. Code Style: Follow the existing code style and conventions. Ensure proper indentation, variable naming, and commenting.

  6. Test Your Changes: Ensure that your changes do not break existing functionality. Write test cases to cover your code changes. Ensure that existing tests pass successfully.

  7. Commit Your Changes: Commit your changes. Write clear and meaningful commit messages. Include a brief summary in the first line followed by a more detailed description if necessary.

  8. Push Changes: Push your changes to your forked repository.

  9. Submit a Pull Request (PR): Once you have pushed your changes, submit a pull request to the main repository. Use a descriptive title for your pull request that summarizes the changes made.

  10. Review Process: Your PR will be reviewed by project maintainers. Please be patient during the review process and be open to feedback and suggestions.

  11. Merge PR: If your PR is approved, it will be merged into the main repository. Congratulations on your contribution!

  12. Stay Engaged: Stay engaged with the community, participate in discussions, and consider contributing further.

Thank you for your interest in contributing to our project! Your contributions help make this project better for everyone.