Here, we are going to show you how you can help us to develop Axe API. But also, we are going to talk about the future plans.
There are several things we already have done and there are many things we want to implement in the future. If you have any opinion about it, please don't hesitate to open an issue for your brilliant ideas on our issue page (opens new window).
You can see what we've done before and what we will work on in the future;
- Easy installation
- Auto API detection
- Extenting a hanler by Hooks and Events.
- Form Validation support
- Custom Middlewares support
- Strong query features
- Model Relation support on routes.
- Recursive Resource support
- Transaction support
- Rate Limit support
- Caching Support on HTTP requests
- System variables in queries ($now, $currentDate, $tomorrow)
- Auto generated API Documentation
- Easy API testing
Also, you can see more about feature requests in the issue list (opens new window).
# Contribution Guide
# What do I need to know to help?
If you are looking to help with a code contribution our project uses NodeJs. If you don't feel ready to make a code contribution yet, no problem! You can also check out the any issues (opens new window) that we have.
# How do I make a contribution?
Never made an open-source contribution before? Wondering how contributions work in our project? Here's a quick rundown!
- Find an issue that you are interested in addressing or a feature that you would like to add.
- Fork the repository associated with the issue to your local GitHub organization. This means that you will have a copy of the repository under your-GitHub-username/repository-name.
- Clone the repository to your local machine using git clone https://github.com/github-username/repository-name.git.
- Create a new branch for your fix using git checkout -b branch-name-here.
- Make the appropriate changes for the issue you are trying to address or the feature that you want to add.
- Use git add insert-paths-of-changed-files-here to add the file contents of the changed files to the "snapshot" git uses to manage the state of the project, also known as the index.
- Use git commit -m "Insert a short message of the changes made here" to store the contents of the index with a descriptive message.
- Push the changes to the remote repository using git push origin branch-name-here.
- Submit a pull request to the upstream repository.
- Title the pull request with a short description of the changes made and the issue or bug number associated with your change. For example, you can title an issue like so "Fixed #4352".
- In the description of the pull request, explain the changes that you made, any issues you think exist with the pull request you made, and any questions you have for the maintainer. It's OK if your pull request is not perfect (no pull request is), the reviewer will be able to help you fix any problems and improve it!
- Wait for the pull request to be reviewed by a maintainer.
- Make changes to the pull request if the reviewing maintainer recommends them.
- Celebrate your success after your pull request is merged!
# Where can I go for help?
If you need help, you can ask questions on our issue list (opens new window).
# What does the Code of Conduct mean for me?
Our Code of Conduct means that you are responsible for treating everyone on the project with respect and courtesy regardless of their identity. If you are the victim of any inappropriate behavior or comments as described in our Code of Conduct, we are here for you and will do the best to ensure that the abuser is reprimanded appropriately, per our code.