Skip to content

Latest commit

 

History

History
67 lines (46 loc) · 2.4 KB

CONTRIBUTING.md

File metadata and controls

67 lines (46 loc) · 2.4 KB
Raw

Contributing to DFS-BFS Graph Traversal

Thank you for your interest in contributing to DFS-BFS Graph Traversal! We welcome contributions from everyone, whether you're a beginner or an experienced developer.

How to Contribute

1. Fork the Repository

Start by forking the repository to your GitHub account.

2. Clone Your Fork

Clone the repository to your local machine using:

$ git clone https://github.com/<your-username>/DFS-BFS-Graph-Travers.git

3. Create a New Branch

Create a branch for your contribution:

$ git checkout -b <branch-name>

4. Make Your Changes

Add new Features, improve documentation, or fix any issues. Be sure to:

  • Document your code with clear comments
  • Ensure that your solution is correct and efficient

5. Commit Your Changes

Commit your changes with a descriptive commit message:

$ git commit -m "Added [Feature-name]"

6. Push to Your Fork

Push your changes to your forked repository:

$ git push origin <branch-name>

7. Create a Pull Request

Go to the original repository and create a Pull Request (PR). Make sure to describe what you’ve changed and why.

Contribution Guidelines

  • Keep your code clean and well-documented.
  • Stick to best practices for the programming language you are contributing in.
  • Respect the folder structure and organization of the repository.

Code Style

Please follow the existing code style in the project. Consistent code style helps maintain readability and makes it easier for everyone to contribute. Ensure that your code passes all linting and formatting checks before submitting.

Writing Tests

If you’re adding a new feature or fixing a bug, please include tests to ensure that your changes don’t break existing functionality. Tests should be written using the existing testing framework in the project.

Documentation

If your contribution changes how the package works, please update the relevant documentation. This includes updating comments, README files, and other markdown files as needed.

Code of Conduct

Please note that this project is governed by a Code of Conduct. By participating in this project, you agree to abide by its terms.

Reporting Issues

If you encounter any issues or have feature requests, please open an issue in the repository to discuss it.

Thank you for your contributions! Together, we can build something amazing. ✨