Skip to content
This repository has been archived by the owner on Jun 27, 2024. It is now read-only.

Latest commit

 

History

History
37 lines (30 loc) · 2.05 KB

README.md

File metadata and controls

37 lines (30 loc) · 2.05 KB
Raw

GitArchived Docs

Welcome to the GitArchived API documentation repository! This repository contains the sources for GitArchived's API documentation, aiming to provide developers with comprehensive information about integrating with GitArchived's services.

Contributing

We greatly appreciate your interest in contributing to the improvement of GitArchived's API documentation. Before you start, please take a moment to review the guidelines outlined below.

Contributing Guidelines

  • Pull Request Order: Each pull request should focus on a single change. Avoid bundling multiple changes into one pull request. Instead, submit separate pull requests for specific, even small, changes. For example, refrain from submitting pull requests like "fix: many fixes".

  • Commit Conventions: Commits must adhere to the conventions of conventional commits and commit linting. Ensure that commit messages are clear, concise, and descriptive of the changes made.

Getting Started

To contribute to the GitArchived API documentation, follow these steps:

  1. Fork the repository to your GitHub account.
  2. Clone the forked repository to your local machine: 
    git clone https://github.com/your-username/docs.git
  3. Create a new branch for your changes: 
    git checkout -b feature-branch-name
  4. Make your desired changes to the documentation.
  5. Commit your changes following the commit conventions.
  6. Push your changes to your forked repository: 
    git push origin feature-branch-name
  7. Create a pull request from your forked repository to the main GitArchived docs repository.
  8. Await review and feedback from the maintainers. Make any necessary adjustments based on the feedback received.
  9. Once approved, your changes will be merged into the main documentation.

License

By contributing to this project, you agree that your contributions will be licensed under the GPL v3 License.

Thank you for your willingness to contribute! We appreciate your efforts in making the GitArchived API documentation even better. ❤️