Skip to content

Latest commit

 

History

History
44 lines (29 loc) · 1.68 KB

CONTRIBUTING.md

File metadata and controls

44 lines (29 loc) · 1.68 KB

Contributing

We welcome contributions from the community! To ensure smooth collaboration, please follow the guidelines below when submitting your changes:

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

  2. Clone your fork: Clone your forked repository to your local machine.

    git clone https://github.com/YOUR-USERNAME/REPO-NAME.git
    
  3. Create a new branch: Always create a new branch for your work, branching off the dev branch.

git checkout dev
git checkout -b feature/your-feature-name
  1. Make your changes: Implement your feature, fix bugs, or make improvements. Be sure to write clean, well-documented code.

  2. Commit your changes: Write clear and concise commit messages.

git add .
git commit -m "Add brief description of your feature or fix"
  1. Push to your fork: Push your changes to your forked repository on GitHub.
git push origin feature/your-feature-name
  1. Submit a pull request (PR): Once your changes are ready, open a pull request (PR) from your feature branch to the dev branch of this repository. Please make sure you do not submit PRs to the main branch.
  • Include a clear description of your changes in the PR.
  • Reference any relevant issues or tickets.

Important Guidelines

  • All pull requests should be made to the dev branch. Contributions submitted to other branches will not be accepted.

  • Ensure your code follows the existing style and conventions used in the project.

  • Run tests (if applicable) to ensure your changes don’t break existing functionality.

Thank you for contributing! We appreciate your help in making this project better.