search

cybertk / abao

REST API automated testing tool based on RAML
MIT License
354 stars 59 forks source link

ES7 Migration - CONTRIBUTING #227

Open oshalygin opened 7 years ago

oshalygin commented 7 years ago

We should establish contributing guidelines and place them in a CONTRIBUTING file.

Leaving this open for discussion.

cybertk commented 7 years ago

We can start with a simple version

sichvoge commented 7 years ago

what about something like this:

Abao is an open source project and your contribution is very much appreciated.

  1. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug.
  2. Fork the repository on Github and make your changes on the develop branch (or branch off of it). 3. Run npm run lint before committing to check for common problems and auto format all code.
  3. Add an example of the new feature to example.raml (if applicable)
  4. Send a pull request (with the develop branch as the target).

If your pull request is merged feel free to ask for push access. We want to get more maintainers! If you do have push access, please still work on feature branches and create pull requests, which then get reviewed. You can also review other people's pull requests and be involved in that way.

A big thank you goes out to everyone who helped with the project, the contributors and everyone who took the time to report issues and give feedback.

We used the same in raml2html.

oshalygin commented 7 years ago

Love it, lets get this together in a PR. Either I can do put it together or you can, lmk. If I don't hear back by the weekend I'll put together a quick PR for this 👍

sichvoge commented 7 years ago

Should I do this against a specific branch?

Update: I will do that against the es7-migration branch.

sichvoge commented 7 years ago

Done!