Skip to content

Latest commit

 

History

History
48 lines (37 loc) · 3.57 KB

handbook-contributing.md

File metadata and controls

48 lines (37 loc) · 3.57 KB
Raw

Contributing to the Handbook

Contribution to the Handbook by an inDrive User

  1. Clone the repository to your local machine using the command: git clone.
  2. Create a branch: use a descriptive name for the branch that reflects the nature of your changes.
  3. Update the documentation: make your updates following the documentation guidelines.
  4. Commit your changes: include a brief commit message summarizing your updates. Provide a detailed description in the pull request and request reviews. The pull request will be automatically assigned to the code owners, as specified in the CODEOWNERS file. If the pull request is not assigned to a code owner or to a particular reviewer, assign the pull request to a code owner manually.
  5. Respond to feedback: address any feedback from reviewers and make necessary updates.
  6. Address the Markdown linter errors if there are any in the logs.
  7. Monitor the pull request: track the pull request for any updates.
  8. Merge your pull request: once approved and ready, merge the pull request.

Contribution to the Handbook by a Non-inDrive User

  1. Fork this repository.
  2. Clone the forked repository to your local machine using: git clone.
  3. Create a branch: use a descriptive name for the branch that reflects the nature of your changes.
  4. Update the documentation: make your updates following the documentation guidelines.
  5. Commit your changes: include a brief commit message summarizing your updates. Provide a detailed description in the pull request and request reviews. The pull request will be automatically assigned to the code owners, as specified in the CODEOWNERS file. If the pull request is not assigned to a code owner or to a particular reviewer, assign the pull request to a code owner manually.
  6. Respond to feedback: address any feedback from reviewers and make necessary updates.
  7. Address the Markdown linter errors if there are any in the logs.
  8. Monitor the pull request: track the pull request for any updates. If necessary, close it.
  9. Merge your pull request: once approved and ready, merge the pull request.

Using Issue Tracker for Making Updates

  1. Creating an issue:
    • go to the Issues tab in the repository and click New Issue;
    • describe the problem or suggest an improvement. Include details like the issue description, where changes are needed, screenshots, or relevant links;
    • click Submit to create the issue.
  2. Issue discussion: use the issue comments to clarify details, make suggestions, or ask questions. This is a space to discuss with other project contributors.
  3. Assigning the issue: the project owner or the issue creator can assign the issue to themselves or another contributor using the Assignees option.
  4. Creating a Pull Request (PR):
    • after making changes in the forked version of the repository, create a Pull Request (PR);
    • in the PR description, reference the issue number with a keyword to automatically close the issue, for example: Fixes #issue_number.
  5. Review and merge:
    • once the PR is created, the team reviews the changes. The PR may be discussed and, after review, merged into the main project branch;
    • after the PR is merged, the issue is automatically closed if the proper keywords (e.g., Fixes) were used.

Key keywords for closing issues:

  • Fixes #issue_number;
  • Closes #issue_number;
  • Resolves #issue_number.