Skip to content

Latest commit

 

History

History
105 lines (73 loc) · 4.76 KB

CONTRIBUTING.md

File metadata and controls

105 lines (73 loc) · 4.76 KB
Raw

Contributing Guidelines

This documentation contains a set of guidelines to help you during the contribution process.
We are happy to welcome all the contributions from anyone willing to improve/add new scripts to this project. Thank you for helping out and remember, No contribution is too small.

Contributing

You can help this library to grow by contributing here. Pick any issue or open one. Let us know what you are working on and ask your questions in the issues itself :)

The package is made up of 2 main folders:

  • /src contains all the resize-observer-hook code
  • /example is our create-react-app based demo website

To setup and run a local copy:

  1. Clone this repo with https://github.com/Gautam-Arora24/resize-observer-hook.git
  2. Run npm install in the root folder
  3. Run npm install in the example folder
  4. In seperate terminal window, run npm start in the root.
  5. In seperate terminal window, run npm start in the example folder.

When you're done working on your changes, submit a PR with the details and include a screenshot if you've changed anything visually.

If you want to contribute to a project, the simplest way is to:

  1. Find a project you want to contribute to
  2. Fork it
  3. Clone it to your local system
  4. Make a new branch
  5. Make your changes
  6. Push it back to your repo
  7. Click the Compare & pull request button
  8. Click Create pull request to open a new pull request

If the reviewers ask for changes, repeat steps 5 and 6 to add more commits to your pull request.

Happy coding!

This project follows the all-contributors specification. Contributions of any kind welcome!

Need more help?🤔

You can refer to the following articles on basics of Git and Github and also contact the Project Mentors, in case you are stuck:

Things to remember while contributing:

  • Please make sure to update tests case wherever necessary.
  • If any package is used that was not present in the requirements.txt, add the package name and the version used to the requirements.txt file. =======

Contributing to resize-observer-hook

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

We Develop with Github

We use github to host code, to track issues and feature requests, as well as accept pull requests.

How to claim an issue?

Checkout this link

How to make a successful Pull Request?

  1. Fork the repo and create your branch from master.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using Github's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue it's that easy!

Write bug reports with detail, background, and sample code

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can.
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

License

By contributing, you agree that your contributions will be licensed under its MIT License.

References

This document was adapted from the open-source contribution guidelines for Facebook's Draft