Skip to content

Latest commit

 

History

History
75 lines (44 loc) · 2.77 KB

CONTRIBUTING.md

File metadata and controls

75 lines (44 loc) · 2.77 KB

Contributing

I am open to, and grateful for, any contributions made by the community. By contributing to How-To-Open-Source, you agree to abide by the code of conduct.

Reporting Issues & Asking Questions

Before opening an issue, please search the issue tracker to make sure your issue hasn't already been reported.

Bugs & Improvements

I use the issue tracker to keep track of bugs and improvements to How-To-Open-Source. I encourage you to open issues to discuss improvements, architecture, theory, internal implementation, etc. If a topic has been discussed before, I will ask you to join the previous discussion.

Getting Help

If you are just asking a question about 'How to ...' please start the title of your issue as: [Question].

I'm not scalable, so help me out!

Please structure questions and issues in a manner that uses syntax highlighting, indentation, & split text into paragraphs. Try to state your question/issue as concisely as possible.

Please keep in mind that I spend my free time trying to help you. You can make it easier for me if you provide versions of the relevant libraries and a runnable small project reproducing your issue. You can put your code on JSBin or, for bigger projects, on GitHub. Make sure all the necessary dependencies are declared in package.json so anyone can run npm install && npm start and reproduce your issue.

Development

Visit the issue tracker to find a list of open issues that need attention.

Fork, then clone the repository:

git clone https://github.com/microauth/microauth-vkontakte.git

Linting & Testing

To run only tests:

yarn test

To run only linting:

yarn start lint

To continuously watch and run tests:

yarn start test.watch

Docs

Improvements to the documentation are always welcome. This goes for the wiki as well.

Examples

Local Example

Sending a Pull Request

In general, the contribution workflow looks like this:

  • Open an issue in the issue tracker.
  • Fork the repository.
  • Create a new feature branch based off the master branch.
  • Make sure all tests and linting pass.
  • Submit a pull request, referencing any issues it addresses.

Please try to keep your pull request focused in scope and avoid including unrelated commits.

After you have submitted your pull request, I'll try to get back to you as soon as possible. I may suggest some changes or improvements.

Thank you for contributing!