Skip to content

Latest commit

 

History

History
55 lines (36 loc) · 2.57 KB

CONTRIBUTING.md

File metadata and controls

55 lines (36 loc) · 2.57 KB

Glassy Notes - Hacktoberfest Contribution Guidelines

Thank you for your interest in contributing to Glassy Notes! We welcome contributions from the open-source community to help make our project even better. Whether you're a developer, designer, or writer, there are various ways you can contribute to our project.

Getting Started

  1. Fork the Glassy Notes GitHub repository to your GitHub account.

  2. Clone your forked repository to your local machine:

    git clone https://github.com/greeenboi/Glassy-Notes.git

  3. Create a new branch and Commit your changes and contributions, Push your changes to the Repository

git checkout -b feature/your-new-feature
git add .
git commit -m "Add your descriptive commit message here"
git push origin feature/your-new-feature
  1. Create a Pull Request (PR) from your forked repository to the main Glassy Notes repository, explaining your changes and improvements. We'll review and merge your PR after it's been reviewed.

Contribution Guidelines

To ensure that your contributions are accepted smoothly, please follow these guidelines:

  • Code Quality: Maintain high code quality, follow best practices, and write clean and well-documented code.

  • Testing: If you're adding new features or modifying existing ones, please include relevant tests in your contribution.

  • Keep It Small: Try to keep your PRs focused on a single issue or feature to make the review process more manageable.

  • Descriptive Commit Messages: Write clear and descriptive commit messages that explain the purpose and changes introduced by your commits.

  • Be Patient: It may take some time for maintainers to review and merge your PR. Please be patient and responsive to any feedback or requests for changes.

What Can You Contribute?

You can contribute to Glassy Notes in various ways:

  • Fixing bugs or issues.
  • Adding new features or enhancements.
  • Improving documentation.
  • Enhancing the user interface (UI) and user experience (UX).
  • Writing tests to improve code coverage.
  • Reviewing and testing existing Pull Requests.

Code of Conduct

Please note that we have a Code of Conduct, and we expect all contributors to adhere to it. Be respectful and considerate of others in your interactions within the Glassy Notes community.

Thank you for considering contributing to Glassy Notes! Your help is greatly appreciated. Together, we can make this project even better.

Happy hacking!

-- with 💖 from greeenboi