Skip to content

Latest commit

 

History

History
54 lines (43 loc) · 1.91 KB

Contribution Guidelines.md

File metadata and controls

54 lines (43 loc) · 1.91 KB

Contribution Guidelines

Thank you for your interest in contributing to BabyNest! We appreciate your efforts in making this project better. Please follow these best practices to ensure smooth collaboration.

How to Contribute

1. Fork the Repository

  • Navigate to the BabyNest repository.
  • Click the Fork button in the top right corner.
  • Clone the forked repository to your local machine: 
    git clone https://github.com/your-username/babynest.git
cd babynest

2. Create a Feature Branch

  • Always create a new branch for your contributions: 
    git checkout -b feature-name

3. Make Changes and Commit

  • Follow coding best practices and maintain code consistency.
  • Write clear commit messages: 
    git commit -m "Added [feature/fix]: Short description"

4. Push Changes and Open a Pull Request

  • Push your changes to your forked repository: 
    git push origin feature-name
  • Navigate to the original repository and open a Pull Request (PR).
  • Provide a detailed description of the changes in the PR.

Best Practices

  • Code Quality: Ensure code is readable, well-documented, and follows project conventions.
  • Testing: Test your changes locally before submitting a PR.
  • Security: Avoid hardcoded credentials or sensitive information in commits.
  • Communication: Be responsive to feedback on PRs and make necessary changes promptly.

Submitting a Video Demonstration

To help maintainers understand your changes, submit a short video showcasing the new feature or bug fix:

  • Record a short demo.
  • Upload the video and share a link in the PR description.

Reporting Issues

If you find a bug or have a feature request:

  • Open an issue here.
  • Clearly describe the problem and suggest possible solutions.

We look forward to your contributions! 🚀