Skip to content

Latest commit

 

History

History
53 lines (34 loc) · 3.82 KB

CONTRIBUTING.md

File metadata and controls

53 lines (34 loc) · 3.82 KB
Raw

Contributing to the Polinema Innovation Tribe Project

Hey! Thank you for considering contributing to the Polinema Innovation Tribe project! We welcome contributions of all kinds, whether you're a student, professional, or just interested in helping out.

How to Contribute?

Here are some ways you can contribute to the project:

  1. Submit issues: If you encounter a bug or have a suggestion for improving the project, please submit an issue.
  2. Fix bugs: If you know how to fix a bug, please consider submitting a pull request.
  3. Implement new features: If you have an idea for a new feature that you would like to see in the project, please submit an issue. to discuss it with the team.
  4. Improve documentation: If you see a mistake in the documentation or have a suggestion for improving it, please submit an issue. or a pull request.
  5. Spread the word: If you like the project, please tell your friends and colleagues about it! You can also share it on social media or write a blog post about it.

How to Pull Request

Here's how to contribute a pull request:

  1. Fork the repository: If you don't already have a copy of the project on your own GitHub account, you'll need to fork the repository to create one. To do this, click the "Fork" button in the top-right corner of the repository page on GitHub. This will create a copy of the repository on your own account.
  2. Clone the repository: Once you have a copy of the repository on your own account, you'll need to clone it to your local machine. To do this, open a terminal and navigate to the directory where you want to store the project. Then run the following command, replacing [YOUR_USERNAME] with your GitHub username and [YOUR_REPOSITORY] with the name of the repository:
git clone https://github.com/[YOUR_USERNAME]/[YOUR_REPOSITORY].git
  1. Create a new branch: Before you start making changes to the code, it's a good idea to create a new branch. This allows you to work on your changes without affecting the main branch of the repository. To create a new branch, run the following command:
git checkout -b [BRANCH_NAME]

Replace [BRANCH_NAME] with a descriptive name for your branch, such as "fix-typo" or "add-feature".

  1. Make your changes: Now you can start making the changes you want to contribute to the project. Make sure to test your changes thoroughly to ensure that they work as intended.
  2. Commit your changes: When you're satisfied with your changes, you'll need to commit them to your local repository. To do this, run the following command
git commit -am "[COMMIT_MESSAGE]"

Replace [COMMIT_MESSAGE] with a brief description of your changes.

  1. Push your changes to GitHub: Now that your changes are committed to your local repository, you'll need to push them to your fork on GitHub. To do this, run the following command:
git push origin [BRANCH_NAME]
  1. Submit a pull request: Once your changes are pushed to your fork on GitHub, you can submit a pull request to the project maintainers. To do this, go to the repository page on GitHub and click the "Compare & pull request" button. This will open a form where you can write a brief description of your changes and submit the pull request for review.

Code of Conduct

We want the Polinema Innovation Tribe project to be an inclusive and welcoming community for everyone. To that end, we have a code of conduct that we ask all contributors to follow. Please make sure you read it before participating.