Skip to content

Latest commit

 

History

History
218 lines (147 loc) · 8.64 KB

CONTRIBUTING.md

File metadata and controls

218 lines (147 loc) · 8.64 KB
Raw

Contributing to Scribbie 🎉

Thank you for considering contributing to Scribbie! We welcome all contributions, whether you're fixing bugs, improving documentation, or adding new features. To help you get started, we've outlined the process for contributing to the project.


Code of Conduct 📃

Please read and follow our Code of Conduct.


Star our Repository ⭐

Stars Forks Issues PRs Open PRs Closed


Need Help With The Basics? 🤔

If you're new to Git and GitHub, no worries! Here are some useful resources:


Project Structure 📂

NOTES-APP/
├── .github/                  # GitHub-related configurations such as workflows, issue templates, etc
│   
├── backend/                  # All the backend development files included here
│   
├── frontend/                 # All the frontend development files included here
│   
├── .gitignore               
│     
├── CODE_OF_CONDUCT.md        # Some rules for the contributors
│   
├── CONTRIBUTING.md           # Instructions for the contributors
│   
├── package-lock.json  
│   
├── package.json      
│   
├── README.md                 # Some instructions about contributions
│   
├── todo

Contribution Guidelines 📚

  • Follow the coding standards and guidelines.
  • Write meaningful commit messages.
  • Ensure your changes do not introduce breaking bugs.
  • Be responsive to feedback and comments from the project maintainers.
  • Respect deadlines and guidelines in case you're working as part of a program (e.g., GSSoC).

We appreciate your contributions and look forward to collaborating with you to make Scribbie a better tool!


First Pull Request ✨

  1. Star this repository Click on the top right corner marked as Stars at last.

  2. Fork this repository Click on the top right corner marked as Fork at second last.

  3. Clone the forked repository

git clone https://github.com/<your-github-username>/notes-app.git
  1. Navigate to the project directory
cd notes-app
  1. Create a new branch
git checkout -b <your_branch_name>
  1. To make changes
git add .
  1. Now to commit
git commit -m "add comment according to your changes or addition of features inside this"
  1. Push your local commits to the remote repository
git push -u origin <your_branch_name>

  1. Create a Pull Request

  2. Congratulations! 🎉 you've made your contribution


Alternatively, contribute using GitHub Desktop 🖥️

  1. Open GitHub Desktop: Launch GitHub Desktop and log in to your GitHub account if you haven't already.

  2. Clone the Repository:

  • If you haven't cloned the project repository yet, you can do so by clicking on the "File" menu and selecting "Clone Repository."
  • Choose the project repository from the list of repositories on GitHub and clone it to your local machine.

3.Switch to the Correct Branch:

  • Ensure you are on the branch that you want to submit a pull request for.
  • If you need to switch branches, you can do so by clicking on the "Current Branch" dropdown menu and selecting the desired branch.
  1. Make Changes:
  • Make your changes to the code or files in the repository using your preferred code editor.
  1. Commit Changes:
  • In GitHub Desktop, you'll see a list of the files you've changed. Check the box next to each file you want to include in the commit.
  • Enter a summary and description for your changes in the "Summary" and "Description" fields, respectively. Click the "Commit to " button to commit your changes to the local branch.
  1. Push Changes to GitHub:
  • After committing your changes, click the "Push origin" button in the top right corner of GitHub Desktop to push your changes to your forked repository on GitHub.
  1. Create a Pull Request:
  • Go to the GitHub website and navigate to your fork of the project repository.
  • You should see a button to "Compare & pull request" between your fork and the original repository. Click on it.
  1. Review and Submit:
  • On the pull request page, review your changes and add any additional information, such as a title and description, that you want to include with your pull request.
  • Once you're satisfied, click the "Create pull request" button to submit your pull request.
  1. Wait for Review: Your pull request will now be available for review by the project maintainers. They may provide feedback or ask for changes before merging your pull request into the main branch of the project repository.

Good Coding Practices 🧑‍💻

  1. Follow the Project's Code Style

    • Maintain consistency with the existing code style (indentation, spacing, comments).
    • Use meaningful and descriptive names for variables, functions, and classes.
    • Keep functions short and focused on a single task.
    • Avoid hardcoding values; instead, use constants or configuration files when possible.

  2. Write Clear and Concise Comments

    • Use comments to explain why you did something, not just what you did.
    • Avoid unnecessary comments that state the obvious.
    • Document complex logic and functions with brief explanations to help others understand your thought -process.

  3. Keep Code DRY (Don't Repeat Yourself)

    • Avoid duplicating code. Reuse functions, methods, and components whenever possible.
    • If you find yourself copying and pasting code, consider creating a new function or component.

  4. Write Tests

    • Write unit tests for your functions and components.
    • Ensure your tests cover both expected outcomes and edge cases.
    • Run tests locally before making a pull request to make sure your changes don’t introduce new bugs.

  5. Code Reviews and Feedback

    • Be open to receiving constructive feedback from other contributors.
    • Conduct code reviews for others and provide meaningful suggestions to improve the code.
    • Always refactor your code based on feedback to meet the project's standards.

Pull Request Process 🚀

When submitting a pull request, please adhere to the following:

  1. Self-review your code before submission. 😀
  2. Include a detailed description of the functionality you’ve added or modified.
  3. Comment your code, especially in complex sections, to aid understanding.
  4. Add relevant screenshots to assist in the review process.
  5. Submit your PR using the provided template and hang tight; we'll review it as soon as possible! 🚀

Issue Report Process 📌

To report an issue, follow these steps:

  1. Navigate to the project's issues section :- Issues
  2. Please kindly choose the appropriate template according to your issue.
  3. Provide a clear and concise description of the issue.
  4. Wait until someone looks into your report.
  5. Begin working on the issue only after you have been assigned to it. 🚀

Thank you for contributing 💗

We truly appreciate your time and effort to help improve our project. Feel free to reach out if you have any questions or need guidance. Happy coding! 🚀