Skip to content

Latest commit

 

History

History
70 lines (50 loc) · 2.87 KB

CONTRIBUTING.md

File metadata and controls

70 lines (50 loc) · 2.87 KB
Raw

Contributing

👋 Hello Ant Media Community, Thanks for contributing😇! Your contributions are not only welcome but also appreciated; no matter if it is just simple bug fixes or even correcting formats or spellings. By participating in this project, you agree to abide by our code of conduct.

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

Table of Contents

  1. Styleguides
  2. What should I know before I get started?
  3. How Can I contribute?
  4. Document Contribution
  5. Pull Requests

Guidelines

The following are the guidelines we request you to follow to contribute to this project.

Styleguides

Code Styleguide

The code should satisfy the following:

  • Have no lint issues.
  • Have a scope for easy fixing, refactoring, and scaling.
  • Have meaningful file names, directory names, and directory structure.
  • Have meaningful variable names, either in snake_case or camelCase.
  • Images you use are losslessly compressed.

What should I know before I get started

You can contribute to any of the features you want, here's what you need to know:

  • How the project works.
  • A brief idea about writing documentation.
  • Try to commit separately for each file you change.
  • You may raise a single PR for all changes but kindly keep your commit history clean.
  • Images help quickly go through the documentation and add referenced images wherever needed.

How Can I Contribute

You can contribute by:

  • Reporting Bugs (Easiest Way)
  • Suggesting Enhancements
  • Code Contribution (Enhancing Docosuras Theme)
  • Raising Pull Requests

Document Contribution

  1. Checkout the latest master branch to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
  2. Check the issue tracker to make sure someone already hasn't requested it and/or contributed to it.
  3. Fork the official documentation repository.
  4. Create your feature branch: git checkout -b doc/my-new-doc
  5. Add your changes: git add .
  6. Commit your changes: git commit -am 'feat: Added missing documentation.'
  7. Push to the branch: git push -u origin doc/my-new-doc
  8. Submit a pull request 😎

Pull Requests

  • Make sure to document the contributions well in the pull request.
  • Make sure, you're raising a pull request to the master branch. Other than the master branch, your PR might not be merged.
  • Pull requests should have: ⋅⋅* A concise commit message. ⋅⋅* A description of what was changed/added.
  • Others contributors may give constructive feedback.
  • This is a time for discussion and improvement, and making the necessary changes will be required before we can merge the contribution.