Skip to content

Latest commit

 

History

History
68 lines (53 loc) · 3.65 KB

CONTRIBUTING.md

File metadata and controls

68 lines (53 loc) · 3.65 KB
Raw

Contributing guidelines

Please follow the below steps to get started on submitting contributions:

  • Navigate to the 'Issues' tab to check if any open issues exist and check for unassigned issues.
  • You can comment and start working on it or wait for the issue to be assigned to you.
  • If you want to add any enhancement or features ,please discuss with maintainer and proceed accordingly.
  • If you have an issue and want to get started,start with forking the project.
  • If you have already forked the project, update your copy before working.
  • Create a new branch and start making the changes.
  • Once you are done with your changes commit,add and push them and open a pull request with the changes.

Refer to the following articles on basics of Git and Github :

Contributing to NOvid-20

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.

We Use Github Flow, So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:

  1. Fork the repo and create your branch from main.
  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)

Use a Consistent Coding Style

Facebook's Guidelines

  • 2 spaces for indentation rather than tabs
  • You can try running npm run lint for style unification

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