Preparation

Axe API is an open-source project that was built by a community. In this section, we are going to talk about how you can contribute to the project.

• You will learn
• What do you need to know about the project?
• Which editor you can use?
• How do you contribute?
• How you can get help?

Getting started

As the Axe API team, we want to provide the best development experiences to the developers who want to contribute to the Axe API project.

In this section, you might find all the things which help you to contribute.

Requirements

To be able to contribute to this project, you should basic knowledge of the following languages, topics, and technologies.

• JavaScript
• TypeScript
• Node.js
• Unit testing
• Integration testing
• RDBMS (MySQL, MariaDB, PostgreSQL, SQLite3, etc.)
• API Best Practices
• Git

Editor

You can select the best editor for yourself to contribute to this project.

Version control

We keep all the codes in Git and we are using GitHub as the remote repository.

You may find all the repositories which we have in Axe API Organization.

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!

Getting help

If you need help, you can ask questions on our issue list.

Code of Conduct

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.

Next steps

In this section, we've covered the fundamentals of the development environment.

In the following section, we are going to talk about the development kit.