Contribute to ReMe

Our community thrives on the diverse ideas and contributions of its members. Whether you’re fixing a bug, adding a new feature, improving the documentation, or adding examples, your help is welcome. Here’s how you can contribute:

Report Bugs and Ask For New Features?

Did you find a bug or have a feature request? Please first check the issue tracker to see if it has already been reported. If not, feel free to open a new issue. Include as much detail as possible:

  • A descriptive title

  • Clear description of the issue

  • Steps to reproduce the problem

  • Version of the ReMe you are using

  • Any relevant code snippets or error messages

Contribute to Codebase

Fork and Clone the Repository

To work on an issue or a new feature, start by forking the ReMe repository and then cloning your fork locally.

git clone https://github.com/your-username/ReMe.git
cd ReMe

Create a New Branch

Create a new branch for your work. This helps keep proposed changes organized and separate from the main branch.

git checkout -b your-feature-branch-name

Making Changes

With your new branch checked out, you can now make your changes to the code. Remember to keep your changes as focused as possible. If you’re addressing multiple issues or features, it’s better to create separate branches and pull requests for each.

Set Up Pre-commit Hooks

Before committing your changes, you should set up pre-commit hooks to ensure code quality and consistency. Pre-commit hooks will automatically check your code for common issues and format it according to the project’s standards.

Install pre-commit:

pip install pre-commit

Install the git hooks:

pre-commit install

Run pre-commit manually (optional): If you want to run pre-commit checks on all files before committing, you can run:

pre-commit run --all-files

After installation, pre-commit will automatically run on git commit to check your code. The hooks will check for:

  • Code syntax and AST validation

  • YAML, XML, TOML, and JSON format validation

  • Trailing whitespace

  • Code formatting (Black)

  • Code style (Flake8)

  • Code quality (Pylint)

  • Package metadata (Pyroma)

If any checks fail, please fix the issues before committing.

Commit Your Changes

Once you’ve made your changes, it’s time to commit them. Write clear and concise commit messages that explain your changes.

git add -A
git commit -m "A brief description of the changes"

Submit a Pull Request

When you’re ready for feedback, submit a pull request to the ReMe main branch. In your pull request description, explain the changes you’ve made and any other relevant context. We will review your pull request. This process might involve some discussion, additional changes on your part, or both.

Code Review

Wait for us to review your pull request. We may suggest some changes or improvements. Keep an eye on your GitHub notifications and be responsive to any feedback.