Skip to content

Latest commit

 

History

History
81 lines (58 loc) · 3.07 KB

contributing.md

File metadata and controls

81 lines (58 loc) · 3.07 KB
Raw

Contributing to api-js

Thank you for your interest in contributing to api-js! We welcome contributions from the community to improve and enhance the framework. Here’s how you can get involved:

How to Contribute

1. Reporting Issues

If you find a bug or have a feature request, please follow these steps:

  1. Check Existing Issues: Search the issues to see if it’s already been reported.
  2. Create a New Issue: If it hasn’t been reported, create a new issue with a clear description of the problem or feature request. Provide any relevant details that might help us understand and address the issue.

2. Pull Requests

We welcome pull requests (PRs) for bug fixes, new features, and improvements. Here’s how to submit a PR:

  1. Fork the Repository: Fork the repository to your own GitHub account.
  2. Clone Your Fork: Clone the forked repository to your local machine. 
    git clone https://github.com/your-username/api-js.git
  3. Create a New Branch: Create a new branch for your changes. 
    git checkout -b my-feature-branch
  4. Make Your Changes: Make your changes in the new branch.
  5. Commit Your Changes: Commit your changes with a descriptive message. 
    git add .
git commit -m "Add feature X or fix bug Y"
  6. Push to Your Fork: Push your changes to your forked repository. 
    git push origin my-feature-branch
  7. Create a Pull Request: Go to the original repository and create a pull request from your branch. Describe the changes you made and why they should be merged.

3. Code Style and Guidelines

To ensure consistency and maintain code quality, please follow these guidelines:

  • Coding Style: Follow the coding style used in the project. Refer to the existing codebase for examples.
  • Documentation: Update documentation as necessary to reflect any changes or new features.
  • Testing: Ensure that your changes are covered by tests and that all tests pass before submitting a PR.

4. Development Setup

To set up a development environment, follow these steps:

  1. Clone the Repository: Clone the repository to your local machine. 
    git clone https://github.com/your-username/api-js.git
  2. Install Dependencies: Navigate to the project directory and install the necessary dependencies. 
    cd api-js
npm install
  3. Run Tests: Ensure that all tests pass before making changes. 
    npm test

5. Code of Conduct

Please adhere to our Code of Conduct while participating in the project. Be respectful and considerate to others.

6. Contact

For any questions or additional information, feel free to reach out to the maintainers:

We appreciate your contributions and thank you for helping make api-js better!

Happy coding!

Note: Replace your-username with your GitHub username or the username of the organization maintaining the project.