Skip to content

Latest commit

 

History

History
66 lines (38 loc) · 2.38 KB

CONTRIBUTING.md

File metadata and controls

66 lines (38 loc) · 2.38 KB
Raw

Contribution Guide

We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

Issues and PRs

If you have suggestions for how this project could be improved, or want to report a bug, open an issue! We'd love all and any contributions. If you have any questions, too, we'd love to hear them.

We'd also love PRs. If you're thinking of a large PR, we advise opening up an issue first to talk about it, though! Look at the links below if you're not sure how to open a PR.

Submitting a pull request

  1. Star the repository⭐

  2. Fork the repository 🍴

  3. Clone your forked copy of the project🌀

    Git clone https://github.com/your_username/Engineering-Notes-Website.git

  4. Navigate to the project directory.

    cd Engineering-Notes-Website

  5. Create a new branch:

    git checkout -b YourBranchName

  6. Make changes in source code.

  7. Stage your changes and commit

    git add . git commit -m "<your_commit_message>"

  8. Push your local commits to the remote repo.

    git push origin YourBranchName

  9. Create a PR

Best Practices for Pull Requests

To increase the likelihood of your pull request being accepted, please follow these best practices:

Follow the coding style:

Ensure that your changes align with the established coding style used in this project.

Write and update tests:

Include tests that cover the functionality you are modifying or adding. If applicable, update existing tests to maintain code coverage.

Keep changes focused:

If you have multiple changes that are independent of each other, consider submitting them as separate pull requests. This allows for better review and easier integration.

Thank you for reading! Happy hacking!

Write a good commit message:

A well-written commit message is important for maintaining clear and concise commit history. Follow the guidelines outlined in this article to create informative commit messages.

Work in Progress (WIP) pull requests:

Feel free to submit work-in-progress pull requests to gather early feedback or when you encounter any obstacles. This allows the community to provide assistance and ensures that your contributions align with the project's goals.

We appreciate your contributions and look forward to reviewing your pull requests!

Help

If you have any issue, please reach out to me at [email protected]