Skip to content

Latest commit

 

History

History
33 lines (25 loc) · 1.85 KB

CONTRIBUTING.md

File metadata and controls

33 lines (25 loc) · 1.85 KB
Raw

Contributing

We welcome contributions to this project!

If you have an idea for a new feature or improvement, please open an issue to discuss it with the community before submitting a pull request.

Here are some guidelines to follow when contributing:

  1. Before making a contribution, please check the project's open issues to see if someone else is already working on something similar. If you have a new suggestion >or have found a bug, please open a new issue to let us know.
  2. If you want to work on an existing issue or have a new idea for a feature, please comment on the issue to let us know that you are working on it. This will help to > prevent duplication of effort.
  3. All contributions should be made via pull request. When submitting a pull request, please make sure to include a clear description of the changes you have made and why they are necessary.
  4. All code contributions should be accompanied by tests to ensure that the changes do not break existing functionality.
  5. If you are making a non-code contribution (e.g. writing documentation, creating graphics), please make sure to follow the project's style guidelines and include any necessary attribution.

To submit a pull request:

  1. Fork the repository.
  2. Create a new branch for your changes.
  3. Make your changes.
  4. Push your changes to your forked repository.
  5. Submit a pull request to the main repository.

Final Guide for code changes:

  1. Fork this repository.
  2. Clone your forked copy of the project
  3. Navigate to the project directory
  4. Create a new branch (git checkout -b YourBranchName)
  5. Make changes in source code.
  6. Stage your changes (git add .) & commit your changes (git commit -m "<your_commit_message>")
  7. Push your local commits to the remote repo( git push origin YourBranchName)
  8. Create a PR

Thank you for your contributions!