Skip to content

Latest commit

 

History

History
94 lines (59 loc) · 2.79 KB

CONTRIBUTING.md

File metadata and controls

94 lines (59 loc) · 2.79 KB

Contributing Guidelines

🎉 First of all, thanks for taking the time to contribute! 🎉

The following is a set of guidelines for contributing to this project. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

How can I contribute? 🤔

Pull Requests 📣

The process described here has several goals:

  • Maintain the project's quality
  • Fix problems that are important to users
  • Engage the community in working toward the best possible!
  • Enable a sustainable system for maintainers to review contributions

Style Guide for Git Commit Messages 📝

How you can add more value to your contribution logs:

  • Use the present tense. (Example: "Add feature" instead of "Added feature")
  • Use the imperative mood. (Example: "Move item to...", instead of "Moves item to...")
  • Limit the first line (also called the Subject Line) to 50 characters or less.
  • Capitalize the Subject Line.
  • Separate subject from body with a blank line.
  • Do not end the subject line with a period.
  • Wrap the body at 72 characters.
  • Use the body to explain the what, why, vs, and how.

🚀 How to Contribute

  • Please create an issue before creating a pull request.

  • Fork the repository and create a branch for any issue that you are working on.

  • Create a pull request which will be promptly reviewed and suggestions would be added to improve it.

  • Add Screenshots to help us know what changes you have done.

🤔 How to make a pull request

1. Fork this repository.

2. Clone the forked repository.

git clone https://github.com/<your-username>/hacktoberfest2021-HTML.git

3. Navigate to the project directory.

cd hacktoberfest2021-HTML

4. Create a new branch:

git checkout -b your-branch-name

5. Make the necessary changes.

6. Stage your changes and commit

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

Follow our commit guide from above

7. Push your local commits to the remote repo.

git push origin your-branch-name

8. Create a new Pull Request from your-branch-name

9. 🎉 Congratulations! You've made your first pull request! Now, you should just wait until the maintainers review your pull request.

Hacktoberfest Guidelines 🌳

Good Practice ✅

  • Comment on the issue to get assigned
  • Create an issue before you make a Pull Request

Bad Practice ❌

  • Creating pull requests without issue assignment will not be accepted and will be closed.

After this, the project maintainers will review the changes and will merge your PR if they found it good, otherwise we will suggest the required changes.