Restgoose

Model-driven REST API framework using decorators

Contributing to restgoose

You are here to help on restgoose? Great, welcome aboard! The following sections in order to know how to ask questions and how to work on something.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.

Restgoose is an open source project and we love to receive contributions from our community — you!

There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into restgoose itself.

Ground Rules

Technical

Community

Working on your first Pull Request? You can learn how from this free series, How to Contribute to an Open Source Project on GitHub.

How to report a security vulnerability

If you find a security vulnerability, do NOT open an issue. Email xureilab@gmail.com instead.

Any security issues should be submitted directly to xureilab@gmail.com. In order to determine whether you are dealing with a security issue, ask yourself these two questions:

If the answer to either of those two questions are “yes”, then you’re probably dealing with a security issue. Note that even if you answer “no” to both questions, you may still be dealing with a security issue. If you’re unsure, just email us at xureilab@gmail.com.

How to report a bug

When filing an issue, make sure to provide these informations:

  1. Version of Node.js that you are using (node --version),
  2. A minimal piece of code reproducing the issue,
  3. The expected result,
  4. The returned result

General questions should go to the subreddit r/restgoose/. Also consider StackOverflow.

How to suggest a feature or enhancement

If you find yourself wishing for a feature that doesn’t exist in restgoose, you are probably not alone. There are bound to be others out there with similar needs.

Simply open an issue with ‘Feature proposal’ in the title, describe the feature you would like to see, why you need it, and how it should work.

Code review process

The core team looks at Pull Requests on a weekly basis. At least one review from the core developers is required for a PR to be merged.

We usually answer to any issue or Pull Request in two working days. The reviewing and merging process takes typically less than a week.

Community

You can discuss with the core team on Reddit: r/restgoose/.