Skip to content

Latest commit

 

History

History
65 lines (38 loc) · 2.03 KB

CONTRIBUTING.md

File metadata and controls

65 lines (38 loc) · 2.03 KB

Contributing Guidelines

Thank you for your interest in contributing to our project! We welcome contributions from everyone. By participating in this project, you agree to abide by our Code of Conduct.

How to Contribute

To contribute to this project, follow these steps:

  1. Fork the repository and clone it to your local machine.

  2. Branch from main to work on your changes:

    git checkout -b my-contribution

    Replace my-contribution with a descriptive name for your branch.

  3. Commit your changes:

    git commit -am 'Added feature / fixed bug / made change'

    Replace 'Added feature / fixed bug / made change' with a brief description of what you've done.

  4. Push your changes to your fork:

    git push origin my-contribution

  5. Open a Pull Request (PR) against the main branch of the original repository.

    In your PR, describe the problem or feature request and how your change addresses it. Reference any relevant issues or PRs.

  6. Discuss and Iterate: Respond to any feedback or suggestions for changes. Be prepared to update your branch and push changes if necessary.

Code Style

  • Follow the existing code style and conventions used in the project.
  • Ensure your code is clean, readable, and well-documented.

Testing

  • Write tests for new features and fixes where applicable.
  • Make sure all tests pass before submitting a PR.

Documentation

  • Update documentation for any changes in functionality or APIs.
  • Provide necessary documentation for new features.

Issue Reporting

  • Feel free to report issues or bugs using the issue tracker.
  • Clearly describe the problem including steps to reproduce when it's a bug.

Code of Conduct

License

By contributing to this project, you agree that your contributions will be licensed under the project's license.