Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
167 lines (108 loc) · 3.29 KB

CONTRIBUTING.md

File metadata and controls

167 lines (108 loc) · 3.29 KB
Raw

Contributing to Dynamic Family Tree

Thank you for your interest in contributing to Dynamic Family Tree! 🌳

Contributions are welcome, whether you're fixing a bug, improving the UI, updating documentation, or adding a new feature.

Getting Started

1. Fork the Repository

Click the Fork button at the top-right of the repository to create your own copy.

2. Clone Your Fork

git clone https://github.com/YOUR-USERNAME/dynamic-family-tree.git

Then navigate into the project:

cd dynamic-family-tree

3. Create a New Branch

Always create a separate branch for your contribution.

For a bug fix:

git checkout -b fix/issue-name

For a new feature:

git checkout -b feature/feature-name

Examples:

git checkout -b fix/future-date-validation
git checkout -b feature/dark-mode

Find an Issue

Check the repository's Issues tab for available tasks.

Good places for new contributors to start are issues labeled:

  • good first issue
  • help wanted
  • bug
  • enhancement

Before starting work, leave a comment on the issue indicating that you would like to work on it.

Make Your Changes

Keep your changes focused on the selected issue.

Please:

  • Write clean and readable code.
  • Keep the existing project structure.
  • Avoid unnecessary dependencies.
  • Maintain responsive behavior.
  • Test your changes before submitting them.
  • Do not include unrelated changes in the same pull request.

Commit Your Changes

Use clear and meaningful commit messages.

Examples:

git commit -m "fix: prevent future dates in date of birth field"
git commit -m "feat: add dark mode toggle"
git commit -m "docs: improve contribution guide"

Push Your Branch

git push origin your-branch-name

Example:

git push origin fix/future-date-validation

Create a Pull Request

After pushing your branch:

  1. Open the original Dynamic Family Tree repository.
  2. Click Compare & pull request.
  3. Add a clear title and description.
  4. Mention the related issue.

For example:

Closes #1
  1. Explain what you changed and how you tested it.
  2. Submit the pull request.

Pull Request Guidelines

Before submitting your pull request, make sure:

  • The project works without console errors.
  • Your changes solve the referenced issue.
  • Existing functionality still works.
  • The UI remains responsive.
  • Your code is easy to understand.
  • Your pull request contains only relevant changes.

Reporting Bugs

If you discover a bug that does not already have an issue:

  1. Open the Issues tab.
  2. Search existing issues first.
  3. Create a new bug report if it has not already been reported.
  4. Explain how the problem can be reproduced.
  5. Include screenshots when helpful.

Suggesting Features

Feature suggestions are also welcome.

Create an issue describing:

  • The feature
  • Why it would be useful
  • The expected behavior
  • Any implementation ideas you may have

Need Help?

If anything about an issue is unclear, leave a comment on that issue before starting.

Questions from new contributors are welcome.

Code of Conduct

Please keep all discussions respectful, constructive, and focused on improving the project.

Thank you for helping improve Dynamic Family Tree! 🌳