Merge pull request #3 from superfaceai/chore/prepare-to-open-repo

docs: prepare to open the repository

Author: janhalama

CONTRIBUTING.md

@@ -0,0 +1,44 @@
+# Contribution Guidelines
+
+We welcome contributions to our [open source project on GitHub](https://github.com/superfaceai/passport-twitter-oauth2).
+
+**Please open an issue first if you want to make larger changes**
+
+## Help the community
+
+1. Report an Error or a Bug
+2. Contribute to the Documentation
+3. Provide Support on Issues
+
+## Need help?
+
+If you have any question about this project (for example, how to use it) or if you just need some clarification about anything, please open an Issue at [Issues](https://github.com/superfaceai/passport-twitter-oauth2/issues).
+
+## Contributing
+
+Follow these steps:
+
+1. **Fork & Clone** the repository
+2. **Setup** the Superface passport-twitter-oauth2
+   - Install packages with `yarn install` or `npm install`
+   - Format code with `yarn format:fix` or `npm run format:fix`
+3. **Update** [CHANGELOG](CHANGELOG.md). See https://keepachangelog.com/en/1.0.0/
+4. **Commit** changes to your own branch by convention. See https://www.conventionalcommits.org/en/v1.0.0/
+5. **Push** your work back up to your fork
+6. Submit a **Pull Request** so that we can review your changes
+
+**NOTE: Be sure to merge the latest from "upstream" before making a pull request.**
+
+**NOTE: Please open an issue first if you want to make larger changes**
+
+### Contribute by reporting bugs
+
+If you are experiencing bug or undocumented behavior please open an Issue with bug template at [Issues](https://github.com/superfaceai/passport-twitter-oauth2/issues).
+
+### Contribute to documentation
+
+Help us improve the documentation, you can report typos, improve examples.
+
+## Copyright and Licensing
+
+The Superface passport-twitter-oauth2 open source project is licensed under the [MIT License](LICENSE).

README.md

@@ -49,7 +49,7 @@ passport.use(
     {
       consumerKey: TWITTER_CONSUMER_KEY,
       consumerSecret: TWITTER_CONSUMER_SECRET,
-      callbackURL: "http://127.0.0.1:3000/auth/twitter/callback",
+      callbackURL: 'http://127.0.0.1:3000/auth/twitter/callback',
     },
     function (accessToken, refreshToken, profile, done) {
       User.findOrCreate({ twitterId: profile.id }, function (err, user) {
@@ -71,17 +71,52 @@ For example, as route middleware in an [Express](http://expressjs.com/)
 application:
 
 ```javascript
-app.get("/auth/twitter", passport.authenticate("twitter"));
+app.get('/auth/twitter', passport.authenticate('twitter'));
 
 app.get(
-  "/auth/twitter/callback",
-  passport.authenticate("twitter", {
-    failureRedirect: "/login",
-    scope: ["tweet.read", "tweet.write", "users.read"],
+  '/auth/twitter/callback',
+  passport.authenticate('twitter', {
+    failureRedirect: '/login',
+    scope: ['tweet.read', 'tweet.write', 'users.read'],
   }),
   function (req, res) {
     // Successful authentication, redirect home.
-    res.redirect("/");
+    res.redirect('/');
   }
 );
 ```
+
+## Development
+
+When developing, start with cloning the repository using `git clone https://github.com/superfaceai/passport-twitter-oauth2.git`.
+
+After cloning, the dependencies must be downloaded using `yarn install` or `npm install`.
+
+Now the repository is ready for code changes.
+
+The `package.json` also contains scripts (runnable by calling `yarn <script-name>` or `npm run <script-name>`):
+
+- `format` - format the code (use `format:fix` to run autofix)
+- `test` - run tests
+
+## Maintainers
+
+- [Jan Halama](https://github.com/janhalama)
+
+## Kudos
+
+- [Jared Hanson](https://github.com/jaredhanson) author of Passport.js
+
+## Contributing
+
+**Please open an issue first if you want to make larger changes**
+
+Feel free to contribute! Please follow the [Contribution Guide](CONTRIBUTING.md).
+
+Note: If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.
+
+## License
+
+`@superfaceai/passport-twitter-oauth2` project is licensed under the [MIT license](LICENSE).
+
+© 2022 Superface s.r.o.