Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(contributing): update contributing.md for get started instructions #16

Merged
merged 1 commit into from
Jan 9, 2024

Conversation

tintayadev
Copy link
Contributor

@tintayadev tintayadev commented Jan 9, 2024

Resolves(#13)

Pull Request description

Since the guide to start contributing was outdated and skipped some needed information, the contributing.md file has been updated. Now, it includes the full guide to set the development environment. And so, ensuring that new contributors can easily understand how to get started.

The following steps were added:

  • Miniforge requirement
  • Use mamba when creating the environment with conda
  • Installation of dependencies with poetry
  • Github token generation
  • Run tests

How to test these changes

  • ...

Pull Request checklists

This PR is a:

  • bug-fix
  • new feature
  • maintenance

About this PR:

  • it includes tests.
  • the tests are executed on CI.
  • the tests generate log file(s) (path).
  • pre-commit hooks were executed locally.
  • this PR requires a project documentation update.

Author's checklist:

  • I have reviewed the changes and it contains no misspelling.
  • The code is well commented, especially in the parts that contain more complexity.
  • New and old tests passed locally.

Additional information

Reviewer's checklist

Copy and paste this template for your review's note:

## Reviewer's Checklist

- [ ] I managed to reproduce the problem locally from the `main` branch
- [ ] I managed to test the new changes locally
- [ ] I confirm that the issues mentioned were fixed/resolved .

@tintayadev tintayadev marked this pull request as ready for review January 9, 2024 23:38
Copy link
Member

@xmnlab xmnlab left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! thanks @tintayadev !

@xmnlab xmnlab merged commit 97e2140 into osl-incubator:main Jan 9, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants