Skip to content

Latest commit

 

History

History
59 lines (42 loc) · 4.39 KB

CONTRIBUTING.md

File metadata and controls

59 lines (42 loc) · 4.39 KB
Raw

Contributing Guidelines for Blogify Project!

Thanks for thinking about contributing to this project! This project was built while I was learning Full-stack web dev, now I am inviting other learners to collaborate and make it even more robust.🤗

This is a great project for working on all skills like coding, writing documentation, writing tests, implementing 3rd party services, etc. If you don't like the sound of any of those, QA is also helpful—you can add bug reports to the issues. All contributions are welcome!

Your First Contribution

Working on your first Pull Request? You can learn how from this free video series. How to Contribute to an Open Source Project on GitHub

Unsure where to begin contributing ? You can start by looking through these documentation and help-wanted issues

Where To Start

To contribute code to this project you can suggest new features, fix an existing functionality for performance or readability, work on open issues, etc. Here's a general guide for contributing:

  1. Find an issue or enhancement to work on. You could find this by using the site or looking through the open issues.
  2. Start a discussion. This step is optional, but if you're making a big change to the codebase or adding a new feature, it's recommended. This will give us a chance to make sure your change or feature is in scope and alignment for the app, and that your work won't conflict with existing work in progress.
  3. Check pending pull requests. Take a look through the pending pull requests to make sure someone else hasn't already started working on the issue you've chosen. New pull requests are always welcome, however duplicate pull requests will not be merged. You can always add new commits to the existing pull request before it is merged—it will get automatically updated.
  4. Fork the repo. You'll find the Fork button in the top-right corner of this repo. Once you're taken to your fork of the repo, use the green Clone or download button to open the project on your local machine. You can check the further installation requirements in the project README.
  5. Commit your changes with meaningful commits. Take a look through previous commits to see how I'm defining this. Don't forget to add yourself to the list of contributors in the project README! Push commits to your fork of the repo.
  6. Submit a pull request. 👍👍
  7. optional Make sure that all the commits in the Pull request are squashed and made into one. In case if u dont know squashing check it here.

Submitting code/PR

Make a simple description of the PR and add a link to the issue.

Add these parameters to your PR for review:

  1. Are you fixing a bug?
  2. Are you changing functionality?
  3. Are you improving performance?
  4. Are you updating documentation?
  5. Add some screenshots of the fix.

How to Report a Bug

When filing an issue, make sure to answer these five questions:

  1. What packages have you installed and what version?
  2. What operating system and processor architecture are you using?
  3. What did you do?
  4. What did you expect to see?
  5. What did you see instead?
  6. Add some screenshots of the expected behaviour and current behaviour.

Templates

Please use issue/PR templates which are inserted automatically.

Resources