Contribution Guide

Please check the project's issue tracker for any open issues or feature requests. If you find an issue you'd like to work on, assign it to yourself and follow the below process for making contributions.

Getting Started

  1. Fork the Repository: Fork the repository to your GitHub account by clicking the "Fork" button in the top right corner of the repository page.

  2. Clone the Repository: Clone the forked repository to your local machine using the following command:

git clone{your-username}/ONEST-Specification.git
  1. Checkout Branch: checkout the `draft` branch.

git checkout draft
  1. Create a Branch: Create a new branch for your contribution:

 git checkout -b feature/your-feature-name

Making Changes:

  1. Code: Make your desired changes or additions to the repository.

Submitting Changes

  1. Commit Changes: Commit your changes with a descriptive commit message:

git commit -m "Add feature/fix: Description of your changes" 
  1. Push Changes: Push your changes to your forked repository:

git push origin feature/your-feature-name
  1. Create a Pull Request: Go to the GitHub page of your forked repository and create a new pull request to the draft branch. Tag the issue ID and provide a clear and concise description of your changes in the pull request template.

Review Process

  1. Code Review: Your pull request will undergo a review process by the project maintainers. Be responsive to any feedback or requests for changes.

  2. Merge: Once your pull request is approved, it will be merged into the main branch.

Last updated