Skip to content

Latest commit

 

History

History
124 lines (79 loc) · 4.83 KB

Contributing.md

File metadata and controls

124 lines (79 loc) · 4.83 KB
Raw

Slate.AI - Contributing Guidelines

Welcome to the Slate.AI project! We're excited to have you contribute. Before you start, please read through the guidelines to ensure a smooth contribution process. Remember, no contribution is too small.

Before Contributing

Make sure to read the entire guidelines before sending your pull requests. If you have any questions, feel free to reach out.

Contribution

We welcome all contributions, from fixing grammatical mistakes to implementing complex features. Please follow these steps:

Refer to this video for more help - https://www.youtube.com/watch?v=deEYHVpE1c8&t=335s

Steps to Contribute

  1. Fork the repo: 
    git clone https://github.com/<your_github_username>/Slate.AI
  2. Clone The repo in your local machine
git remote add upstream https://github.com/<original_repo_owner>/Slate.AI.git
  1. Keep your repo up to date by pulling from upstream (this will also avoid any merge conflicts while committing new changes
git pull upstream main
  1. Create your feature branch(importent step, so don't skip it)
git checkout -b <feature-name>
  1. Track and stage your changes
git status
git add .
  1. Push the changes to your remote forked repo
git push origin <branch-name>
  1. Create a PR on Github. (Don't just hit the create a pull request button, you must write a PR message to clarify why and what are you contributing)

Create PR on only "dev" branch(not in the main branch)

Procedure to Make a Pull Request (PR)

To create a pull request, follow these steps:

  1. Go to your fork of the repository on GitHub.
  2. Click the Pull Requests tab.
  3. Click the New pull request button.
  4. Select the branch that you want to merge into the upstream repository.
  5. Click the Create pull request button.

Once you have created a pull request, the project maintainers will review your changes and merge them into the upstream repository if they are approved.

Writing a Pull Request

When writing a pull request, be sure to include the following information:

  • A clear and concise description of your changes.
  • Any relevant documentation or test cases.
  • Links to any related issues or pull requests.
  • It is also a good idea to test your changes thoroughly before submitting a pull request.

Your Pull Request(PR) will be reviewed by the maintainers, and once approved, your changes will be merged into the main repository.

🔨Note:

  • Do not edit/delete someone else's script in this repository. You can only insert new files/folders into this repository.
  • Give a meaningful name to whatever file or folder you are adding.
  • Try to add descriptive comments on your code.

Guidelines

  1. Welcome! If you are here as a participant/contributor, comment on issues you'd like to work on, and mentors will assign you.
  2. Issues are assigned on a first-come, first-served basis.
  3. Participants can open their issues using issue_template, verified and labeled by a mentor or PA.
  4. Each participant gets 1 issue (max) at a time to work.
  5. Follow project guidelines and coding style; structured code is a priority.
  6. Explain your approach to solving an issue in the comments to increase chances of assignment.
  7. Don't create issues already listed.
  8. PRs will be merged after review by a mentor or PA.
  9. PRs must be from a branch other than main.(YOUR FEATURED BRANCH)
  10. Complete issues before the deadline. If you fail, the issue may be assigned to another contributor.
  11. Include the issue number (Fixes: issue number) in your PR commit message.
  12. Ensure your solution is better in terms of performance and other parameters.
  13. For extensive changes, please open an issue first to discuss your ideas.

📝 Project Structure for All Kind of Issues and PR's :

Create an issue with your idea, approach, your expected outcome and why it's useful to be necessary to be included in this project. For PR, include issue number along with PR template, it's details and compiled output screenshot

🤔Need more help?

You can refer to the following articles on the basics of Git and Github and also contact me, in case you are stuck:

🎉 🎊 😃 Happy Contributing 😃 🎊 🎉