Skip to content

Latest commit

 

History

History
39 lines (20 loc) · 2.06 KB

CONTRIBUTING.md

File metadata and controls

39 lines (20 loc) · 2.06 KB
Raw

How to Contribute

One of the easiest ways to contribute is to participate in discussions and report issues. You can also contribute by submitting pull requests with code changes.

Report Issues

We use Github issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.

General Discussions

We’re using GitHub Discussions as a place to connect with other members of our community.

Contributing Code and Content

This is a rough outline of what a contributor's workflow looks like:

  1. Search GitHub Pull Requests for an open or closed PR that relates to your submission in order to avoid duplicate effort.

  2. Fork the repo and create your branch topic from master.

  3. Make your changes in a new git branch.

  4. Make sure your code lints by running npm run lint command if present.

  5. Run the build with npm run build and test with npm run test command, and ensure that all builds and tests succeed.

  6. Commit your changes using a descriptive commit message that follows our commit message conventions.

  7. Push your branch to GitHub forked repo.

  8. In GitHub, submit a pull request to myanmartools/myanmar-text-extractor-js.

  9. If you haven’t signed the CLA, you will see a automatic comment in the pull request. Click on the Details link. You will see the CLA. Click on sign in with Github to agree. And authorize CLA assistant to use your Github account to sign the CLA.

That's it! Thank you for your contribution. After your pull request is merged, you can safely delete your branch topic.

License

By contributing to, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.