Skip to content

Latest commit

 

History

History
54 lines (35 loc) · 2.2 KB

CONTRIBUTING.md

File metadata and controls

54 lines (35 loc) · 2.2 KB
Raw

Contribution Guidelines

Thank you for considering contributing to the Note-Taking App! We welcome contributions from the community to improve and enhance this project. Before you start contributing, please read and follow these guidelines.

How to Contribute

  1. Fork the Repository: Click on the "Fork" button on the top right of the repository page. This will create a copy of the project in your GitHub account.

  2. Clone the Repository: Clone your forked repository to your local machine using the following command:

    git clone https://github.com/your-username/note-taking-app.git

  3. Create a Branch: Create a new branch for your contribution. Use a branch name that describes the feature or bug you are working on.

    git checkout -b feature-name

  4. Make Changes: Make your changes or additions to the codebase. Ensure that your code follows the project's coding standards.

  5. Test Locally: Test your changes locally to ensure that they work as expected.

  6. Commit Changes: Commit your changes with a descriptive commit message.

    git add .
git commit -m "Add a concise commit message"

  7. Push to GitHub: Push your changes to your forked repository on GitHub.

    git push origin feature-name

  8. Create a Pull Request: Open a pull request (PR) on the original repository. Provide a clear and detailed description of your changes in the PR.

Code Standards

  • Follow the coding style and conventions used in the existing codebase.
  • Write meaningful commit messages that describe the purpose of the changes.

Issue Reporting

If you find any issues or have suggestions for improvement, please create a GitHub issue. Clearly describe the problem or enhancement you are proposing, and provide steps to reproduce the issue if applicable.

Communication

  • Feel free to join the discussion in the GitHub issues.
  • For major changes, it's advisable to discuss them first by opening an issue.

License

By contributing to this project, you agree that your contributions will be licensed under the MIT License. See the LICENSE file for more details.

Thank you for contributing to the Note-Taking App! Your efforts are greatly appreciated.