Skip to content
NumLex

How to Contribute

We welcome contributions from the community! Whether you’re fixing a bug, adding new features, or improving documentation, your efforts make NumLex better for everyone.

Getting Started

  1. Fork the Repository: Start by forking the NumLex repository to your GitHub account.

  2. Clone the Fork: Clone your fork to your local machine.

    Terminal window
    git clone https://github.com/Jenil-Desai/NumLex.git

  3. Create a Branch: Always create a new branch for your work.

    Terminal window
    git checkout -b feature-name

  4. Make Your Changes: Develop your features or fixes.

  5. Commit Your Changes: Commit your changes with a clear and concise message.

    Terminal window
    git commit -m "Add feature X"

  6. Push Your Branch: Push your branch to GitHub.

    Terminal window
    git push origin feature-name

  7. Create a Pull Request: Go to the original repository and create a pull request from your branch.

Code Style

  • Follow PEP 8 guidelines for Python code.
  • Ensure your code is well-documented.
  • Write unit tests for new features and bug fixes.

Reporting Issues

If you find a bug or have a feature request, please open an issue on GitHub. Provide as much information as possible, including steps to reproduce the issue.

Happy coding!