Skip to content

Latest commit

 

History

History
86 lines (56 loc) · 2.99 KB

CONTRIBUTING.md

File metadata and controls

86 lines (56 loc) · 2.99 KB

Contributing to React Resume Builder

Welcome to the React Resume Builder project! We appreciate your interest in contributing. By contributing to this project, you help us make it even better. Please take a moment to read this document to understand how you can contribute effectively.

Getting Started

  1. Fork the repository to your GitHub account.

  2. Clone your forked repository to your local machine:

    git clone https://github.com/your-username/react-resume-builder.git

  3. Install the required dependencies:

    cd react-resume-builder
npm install

  4. Create a new branch for your work:

    git checkout -b feature-or-fix-branch

  5. Make your changes and commit them with a clear and concise message:

    git commit -m "Add feature or fix"

  6. Push your changes to your GitHub fork:

    git push origin feature-or-fix-branch

  7. Open a Pull Request (PR) from your fork to the main repository, explaining your changes and their purpose.

Code Style and Guidelines

Follow the Airbnb JavaScript Style Guide:

Use Meaningful Variable and Function Names:

  • Choose descriptive names for variables and functions to enhance code readability.

Keep Code DRY (Don't Repeat Yourself) and Modular:

  • Promote code reusability by avoiding redundancy and breaking down code into modular components.

Write Clear and Concise Comments When Necessary:

  • Use comments to explain complex logic, document edge cases, or provide context where code may not be self-explanatory.

Documentation

Document Your Code:

  • Document your code, especially if it introduces new features or alters existing ones. Clear documentation helps other contributors understand your changes.

Update the README.md File:

  • Include relevant information about new features or changes in the README.md file to keep users and contributors informed.

Pull Request Guidelines

Provide a Clear Title and Description:

  • Ensure your Pull Request (PR) has a meaningful title and description that explain the purpose and impact of your changes.

Pass Existing Tests:

  • Make sure your code passes the existing tests in the project.

Include Documentation for New Features:

  • If you're introducing a new feature, update the documentation to reflect these changes.

Be Responsive to Feedback:

  • Actively engage with comments and feedback on your PR to improve the quality of your contribution.

Reporting Issues

Report Bugs and Feature Requests:

  • If you encounter a bug or have a feature request, please open an issue on the GitHub repository. Provide detailed information, including steps to reproduce the issue and your environment.

Code of Conduct

Follow the Code of Conduct:

  • Please note that this project adheres to a Code of Conduct. Treat all interactions with respect and consideration.

Thank you for your contributions!