Skip to content

Latest commit

 

History

History
91 lines (64 loc) · 2.7 KB

Contributing.md

File metadata and controls

91 lines (64 loc) · 2.7 KB
Raw

Contributing to Retro

We’re excited that you want to contribute to Retro! The following is a set of guidelines to help you contribute effectively and ensure consistency within the project.

How to Contribute

1. Fork the Repository

Click on the "Fork" button at the top of the repository’s GitHub page. This will create a copy of the repository in your GitHub account.

2. Clone the Forked Repository

Clone the forked repository to your local machine using the command below:

git clone https://github.com/<your-github-username>/Retro

3. Add Remote Upstream

Add a remote upstream to keep your fork updated with the original repository:

git remote add upstream https://github.com/original-owner-username/Retro

4. Create a New Branch

Before making changes, create a new branch for your work:

git checkout -b <your-branch-name>

5. Make Your Changes

Make the necessary changes to the codebase.

6. Stage Your Changes

Once you’ve made your changes, stage them for commit:

git add <file1> <file2> ...

7. Commit Your Changes

Commit your changes with a descriptive message:

git commit -m "A meaningful message describing the change"

8. Push Your Changes

Push your changes to your forked repository:

git push origin <your-branch-name>

9. Create a Pull Request (PR)

Go to your forked repository on GitHub. You should see a prompt to create a pull request. Compare the changes and create the PR. Ensure to fill in details about the changes you’ve made.

Guidelines

Reporting Bugs

If you encounter any bugs, feel free to report them. Please ensure you include:

  • A clear and descriptive title.
  • A description of the issue and how to reproduce it.
  • Expected behavior vs. actual behavior.
  • Any error messages or logs that might help.

Suggesting Features or Enhancements

We welcome new ideas and suggestions! To propose a new feature:

  • Open an issue with a feature request label.
  • Provide a clear description of the feature and how it improves the project.

Submitting Code

  • Keep your pull requests focused on a single change to make reviews easier.
  • Follow the project’s code style.
  • Ensure your code is properly tested before submitting.

Commit Message Format

  • Use meaningful and descriptive commit messages.
  • Use the imperative mood (e.g., "Add feature" instead of "Added feature").

Development Setup

To set up a local development environment:

  1. Fork and clone the repository (as mentioned above).
  2. Follow the installation steps in the README to get the project running locally.

Thank you for contributing to Retro! We appreciate your time and effort in helping us improve the project.