Skip to content
This repository has been archived by the owner on Apr 22, 2023. It is now read-only.

CONTRIBUTIONS

Nyambati Thomas edited this page Nov 14, 2016 · 2 revisions

Contributions to these project can be made in the following capacity:

  • New feature suggestions
  • Bug Fixes
  • Documentations
  • Blogs

How to contribute

The philosophy behind this project is to make ACL management in Express based projects as easy as possible. It is my believe that no man can exhaust all ideas to solving a problem. That's why new Ideas to make this project awesome.

How to make a contribution suggestions/requests

New contribution requests can be made through adding Issues. Our team will look into the viability of the idea and how that fits the overall goal of this project. You may be required to answer few questions before your idea is added to our backlog. We use ZenHub to manage this project, therefore we recommend you install it to get access to our boards.

New Issue template

#### {type}-{issue title}

#### {type} definition(provide screenshots if possible)
#### Proposed solutions(if any)

Sample Issue

Feature-Add custom error message

Feature definition

We should be able to add customised error message when a user is denied access to a resource. This will make it provide consistency in messages sent to the client.

Proposed solution

Add a second parameter to the config method which holds the custom message as an object.

acl.config(configObject, {
    status:"UNAUTHORISED ACCESS"
    message: "YOU ARE NOT ALLOWED TO ACCESS THIS RESOURCE, CONTACT ADMIN FOR CLEARANCE"
});

Legend

type - type of issue you are adding

  • Feature
  • Bug
  • Inquiry
  • Documentation
  • Blogs

I have no ideas to add, How can I help?

If you have no suggestions or ideas to add, you can pick any open issue from our project and start tinkering. I would recommend though you make you intentions known by commenting and asking questions to avoid two people working on the same issue.