diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d12fbbcee7..25323d4a55 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,25 +1,38 @@ ## How to contribute? ### Pre-requisites -- Register for the [Open Source Contributor Program](https://bit.ly/3F8Jsjr) so we can add you to the team of contributors in the Naas GitHub organization. To start working on our repository, you must be a part of our [open-source contributors team](https://github.com/orgs/jupyter-naas/teams/opensource-contributors). Please check your email and validate the invitation before you begin working on a new issue. -- Open a [free account on Naas Lab](https://app.naas.ai/) so we can test the templates in a similar environment. +Register for the [Open Source Contributor Program](https://bit.ly/3F8Jsjr) so we can add you to the team of contributors in the Naas GitHub organization. -### Step 1: Create or Select an Issue +To start working on our repository, you **MUST** be a part of our [open-source contributors team](https://github.com/orgs/jupyter-naas/teams/opensource-contributors). + +Please check your email and validate the invitation before you begin working on a new issue. -Identify or propose an issue you wish to work on. It could be a snippet of Python code, an API integration with a tool you are using, or an automation leveraging existing templates with our scheduler, asset, or webhook features. Before you start working on a task, it's important to properly prepare the issue: +### Step 1: Create or Select an Issue +- Identify or propose an issue you wish to work on. It could be a snippet of Python code, an API integration with a tool you are using, or an automation leveraging existing templates with our scheduler, asset, or webhook features. - Make sure the description is clear and concise. - Tag yourself in the Assignees section. -- Create a new branch from the Issue in the Development section. +- Click on "Create a new branch" on the Development section on the right side. +- Mentionned @FlorentLvr in a comment to let us you started working on it. -If the Issue is already created, mentionned @FlorentLvr or @srini047 in a comment to be assign to the Issue. +### Step 2: Technical Setup -If it's your first contribution, we will review your application (Pre-requisites) and you will receive an email inviting you to join our team! +- Create your [GitHub personal access token](https://github.com/settings/tokens). Select “No expiration” and tick only the first section repository and keep your token safe as you won’t be able to generate it again. This token will allow you to commit, push and pull directly on our repository. +- Clone the awesome-notebooks repository and switch to the branch you created. -### Step 2: Technical Setup +```bash +# First, clone the repository +git clone https://github.com/jupyter-naas/awesome-notebooks.git + +# Navigate into the cloned directory +cd awesome-notebooks -Create your [GitHub personal access token](https://github.com/settings/tokens). Select “No expiration” and tick only the first section repository and keep your token safe as you won’t be able to generate it again. This token will allow you to commit, push and pull directly on our repository. -Clone the awesome-notebooks repository on your Naas Cloud account and switch to the branch you created. +# Fetch all branches from the repository +git fetch + +# Checkout to the specific branch you want +git checkout branch_name +``` ### Step 3: Work on Your Notebook @@ -36,12 +49,25 @@ Start working on your notebook. Commit your work every time you make significant - feat: update tags, author, and description - feat: developing function in model to… - fix: adding try except to manage error on… -- Once you're satisfied with the result, push to the branch by clicking on the icon on top (make sure you use a GitHub personal access token and not a password, otherwise, it won’t work). -- Ensure the notebook respects the framework. +- Once you're satisfied with the result, push to the branch. + +```bash +# Navigate into the cloned directory +cd awesome-notebooks + +# Add new template +git add Tool/Tool_Your_template.ipynb + +# Commit with message +git commit -m "feat: xxxx" + +# Push your work +git push +``` ### Step 4: Open a Pull Request -Open a Pull Request and add a Templates Maintainer as Reviewer: Florent (@FlorentLvr) or Srini (@srini047). +Open a Pull Request and add a Templates Maintainer as Reviewer: Florent (@FlorentLvr). - Comment on the Pull Request with a brief summary of what you've done. - You will now discuss your work on the PR. If any changes are made, ensure you pull the branch before working on it again by clicking on the button at the top.