Skip to content

Latest commit

 

History

History
144 lines (94 loc) · 5.36 KB

Contributing.md

File metadata and controls

144 lines (94 loc) · 5.36 KB
Raw

Contributing

Hi there! We're thrilled that you'd like to contribute to Hacktoberfest by Symbl.ai.

When contributing to this repository, please raise an issue for the change you wish to make. It would be appreciated if you discuss the changes with the maintainers/owners of this repository.

Opening an issue

Before opening an issue, Please make sure that your issue is not already reported.

Here are a few things that will help us help resolve your issues:

  • A descriptive title that gives an idea of what your issue refers to.
  • A concise description of what you're experiencing.
  • Steps to reproduce the behavior.
  • Screenshots (if appropriate)
  • Links (if appropriate)

IMPORTANT NOTICE

Symbl Twilio Video React

Please before you push your codes to the repository make sure you pull from the repository, so the changes that have been made can be reflected on your local machine, for us to avoid merge conflicts use the git command line

git pull upstream develop

Developers guide.

This process here should be able to guide you on how to contribute effectively to this project, follow the steps below. You should not be new to the git workflow process however if you still are, the guide should still be able to help you through the process.

Master is the default branch.

  • Fork the repository to generate a copy of your own.

  • Clone the repository.

     git clone 'your forked repo link'

  • Checkout from develop branch to a new branch

      git checkout -b feat/chore/bugs/fix/docs(just choose one)/branch-name

  • Make the original symbl-twilio-video-react repository the remote upstream (at upstream)

    git remote add upstream https://github.com/symblai/symbl-twilio-video-react.git

  • To confirm the remote upstream/origin

    git remote -v

  • Make your changes, add them

    git add .

    Make your commits

    git commit -m "your message"

    Write good commit messages, this is very important, so people reviewing can know what your fix, feature e.t.c. is doing

  • Push your codes to the branch on your forked remote upstream repository - "for-example: git push origin feat/landing-page"

    git push origin your-branch-name

Make your Pull request from that branch of your repository to the develop branch of this (symbl-twilio-video-react) repo and wait for it to be merged.

Write good commit messages, this is very important, so people reviewing can know what your fix, feature e.t.c. is doing. Your PR should carry the story / task URL (instruction from above). if you are going to make changes to an existing code, state why you are doing so in the commit messages.

It is not just about the code, user workflow matters too!!

Commit Structure

  • type: subject e.g body, footer

The title consists of the type of the message and subject. The type is contained within the title and can be one of these types:

  • feat: a new feature

  • fix: a bug fix

  • docs: changes to documentation

  • style: formatting, missing semi colons, etc; no code change

  • refactor: refactoring production code

  • test: adding tests, refactoring test; no production code change

  • chore: updating build tasks, package manager configs, etc; no production code change

An example of a good commit message

feat: Make login check for email and password

More detailed explanatory text, if necessary. Wrap it to about 72 characters or so. In some contexts, the first line is treated as the subject of the commit and the rest of the text as the body. The blank line separating the summary from the body is critical (unless you omit the body entirely); various tools like log, shortlog and rebase can get confused if you run the two together. Explain the problem that this commit is solving. Focus on why you are making this change as opposed to how (the code explains that). Are there side effects or other unintuitive consequenses of this change? Here's the place to explain them.

  • Further paragraphs come after blank lines.
  • Bullet points are okay, too
  • Typically a hyphen or asterisk is used for the bullet, preceded by a single space, with blank lines in between, but conventions vary here
  • If you use an issue tracker, put references to them at the bottom, like this: Resolves: #123 See also: #456, #789 And if your commit is just a simple thing, then make the message very short, but not just a title

Happy hacking!!!!

Hacktoberfest

  • One Good issue raised or a valid pull request accepted will be eligible for Symbl.ai Stickers.
  • Two or more open and valid pull requests to the repository will be eligible for Symbl.ai Tshirt.
  • Sending Feedbacks & discussing new features/Bugs
    We love feedbacks! Sending feedback is a great way for us to understand your different use cases/issues raised. If you had any issues, bugs, or want to share about your experience, feel free to do so on our at our support channel of Community Slack.
  • Contributor Swag Form
    Please fill out the Contributor Submissions Form once you have raised PRs for hacktoberfest.

Resources