Skip to content

Latest commit

 

History

History
88 lines (62 loc) · 2.64 KB

CONTRIBUTING.md

File metadata and controls

88 lines (62 loc) · 2.64 KB
Raw

Contributing to The Project

Welcome to the NotesJar repository! We appreciate your interest in contributing.

Table of Contents

Getting Started

  1. Fork the repository.

  2. Clone the forked repository to your local machine:

    git clone https://github.com/your-username/NotesJar.git

  3. Create a new branch for your feature or bug fix:

    git checkout -b feature-name

  4. Make your changes and commit them with a clear and concise message: how to write a better git commit them with a clear and concise message: FreeCodeCamp

    git add .
git commit -m "Your clear and concise message"

  5. Push your changes to your fork:

    git push origin feature-name

  6. Open a pull request, referencing relevant issues.

    The PR should contain about:

    1. the problem or issue tag
    2. the solution approach you have made
    3. any big file changes
    4. any bug/issue that can arise from the changes.

Code Style

Please follow the existing code style in the project. If there's a specific style guide, mention it here.

Reporting Bugs

If you find a bug, please help us fix it by following these steps:

  1. Check if the issue has already been reported.
  2. If not, create a new issue with a descriptive title and clear steps to reproduce the bug.

Feature Requests

We welcome suggestions for new features. To request a new feature:

  1. Check if the feature has already been requested.
  2. If not, create a new issue with a descriptive title and details about the proposed feature.

Contribution Process

  • If you are working on an existing issue, comment on it to let others know.
  • If you want to work on a new feature, create an issue first to discuss it with the maintainers.

Pull Request Guidelines

Please follow these guidelines when submitting a pull request:

  1. Keep your changes focused and avoid unrelated modifications.
  2. Ensure your code adheres to the existing coding standards.
  3. Include relevant tests for your changes.
  4. Provide a clear and concise description of your pull request.

License

By contributing to this project, you agree that your contributions will be licensed under the [Project License].

Thank you for contributing to NotesJar! 🚀