Skip to content

Latest commit

 

History

History
executable file
·
80 lines (52 loc) · 2.94 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
80 lines (52 loc) · 2.94 KB

Contributing to T-reX

We welcome contributions to the T-reX project. This document outlines the process for contributing to the project's development. Your input is valuable, and we appreciate your support in making this tool more effective and accessible.

At the very least, you can contribute by reporting bugs or suggesting improvements in the issues section of the repository. If you're interested in contributing code, please read the following guidelines. It can be intimidating at first, it was for me, but it's not as hard as it seems. If you have any questions, please feel free to reach out to me at T-reX@scmcd.ch

Types of Contributions

  1. Code Contributions: Enhancements, bug fixes, or new features.
  2. Documentation: Improvements to existing documentation or new documentation.
  3. Testing: Reporting bugs, issues, or inconsistencies in the application.
  4. Feature Suggestions: Ideas for new features or improvements to existing ones.

How to Contribute

Setting Up Your Environment

  1. Fork the Repository: Start by forking the T-reX repository on GitHub.

  2. Clone Your Fork: Clone your fork to your local machine using the command:

    git clone https://github.com/[your-username]/T-reX.git

  3. Set Up a Development Environment: We recommend using a virtual environment. For example:

    python -m venv T-reX-env
source T-reX-env/bin/activate
git clone http://github.com/Stew-McD/T-reX.git
cd T-reX
pip install -e .

Making Changes

  1. Create a New Branch: Work on a new branch for each separate piece of work.

    git checkout -b [your-branch-name]

  2. Make Your Changes: Implement your changes, adhering to the existing code style.

  3. Test Your Changes: Ensure that your changes do not break existing functionality.

  4. Document Your Changes: Update or add documentation as necessary.

Submitting Changes

  1. Commit Your Changes: Write clear and meaningful commit messages.

    git commit -am "Add a concise commit message"

  2. Push to Your Fork: Push your changes to your fork on GitHub.

    git merge upstream
git push origin [your-branch-name]

  3. Create a Pull Request: Submit a pull request to the main repository. Please provide a clear description of the problem you're solving and the proposed solution.

Contribution Guidelines

  • Ensure that your code adheres to the existing style in the project.
  • Write clean, maintainable, and testable code.
  • Follow best practices for Python development.
  • Update or create new tests as necessary.
  • Document your code and update the README or other documentation as needed.

Reporting Issues

If you find a bug or have a suggestion for improvement:

  • Check if the issue has already been reported.
  • If not, create a new issue providing a detailed description and steps to reproduce it.