Skip to content

Latest commit

 

History

History
168 lines (107 loc) · 8.07 KB

CONTRIBUTING.md

File metadata and controls

168 lines (107 loc) · 8.07 KB
Raw

🎇Contributing Guidelines

This documentation contains a set of guidelines to help you during the contribution process.

We're happy to welcome all the contributions from anyone willing to add new scripts to this repository. Thank you for helping out and remember, no contribution is too small.

🙌Contribution

Any contribution is accepted, from fixing grammatical mistakes to implementing complex algorithms. Please read this section if you are contributing your work.

🔖Steps to Contribute

  1. Fork and clone the project repository.

  2. Go through the codebase.

  3. If you see any bugs, issues, or have suggestions for improvements, please open an issue on our GitHub Issues page. Note that you can also work on existing issues from the Issue tab.

  4. Ask project admins to assign the issue you wish to work on. Wait until you are assigned. Any contribution made without being assigned will be deemed as invalid.

  5. Create a new branch for your contribution: git checkout -b feature/your-feature-name.

  6. Make your changes and commit them: git commit -m 'Add your feature or fix'.

  7. Push your changes to your forked repository: git push origin feature/your-feature-name.

  8. Open a pull request (PR) to the main branch of the Cert Vault repository.

  9. Ensure that your PR includes a clear description of the changes and why they are beneficial.

  10. Our maintainers will review your contribution and may provide feedback or request changes.

  11. Once your PR is approved, it will be merged into the main project.

Code Style

Please follow the existing code style and formatting guidelines in the project. Consistency is important.

Reporting Issues

If you encounter any bugs, issues, or have suggestions for improvements, please open an issue on our GitHub Issues page.

Community Guidelines

We aim to foster an open and inclusive community. Please be respectful and considerate in all interactions. Harassment or offensive behavior will not be tolerated.

Thank you for contributing to Cert Vault! Together, we can make this project even better.

Contributions are always welcome!

  1. Fork the Repository

  2. Clone the Repository

    Once you have forked the repository, clone it to your local development environment using the following command:

    https://github.com/<your_github_username>/OpenSourceHackFest.git

    Replace your-username with your GitHub username.

  3. Create a Branch

    Move into the project's directory and create a new branch for your contributions:

    cd OpenSourceHackFest
git checkout -b my-feature-branch

    Replace my-feature-branch with a descriptive branch name related to your changes.

  4. Make Your Changes

    Now it's time to work on your contributions!

  5. Check the changed files

    git status

  6. Commit Your Changes

    git add .
git commit -m "<EXPLAIN-YOUR_CHANGES>"

  7. Push to Your Forked Repository

    git push origin my-feature-branch

    Replace my-feature-branch with the name of your branch.

  8. Create a Pull Request

    Go to your forked repository on GitHub, and you should see a "Compare & pull request" button. Click on it to create a pull request (PR) from your branch to the main CertVault repository.

🔨Note:

  • Do not edit/delete someone else's code in this repository. You can only insert new files/folder in this repository.
  • Give a meaningful name to whatever file or folder you are adding. (For e.g., if you have written a Deep Learning code on Loan Prediction, then loan_prediction.py is one example of valid name)

🔑Guidelines

  1. Welcome to this repository, if you are here as open source program participant/contributor.
  2. Participants / contributors have to comment on issues they would like to work on, and mentors or the PA (Project Administrators) will assign you.
  3. Not that you cannot begin working on a particular issue without being assigned to by PAs.
  4. Issues will be assigned on a first-come, first-serve basis.
  5. Please discuss with the team once before opening your issues. We respect all your contributions, whether it is an Issue or a Pull Request.
  6. When you raise a issue, make sure you get it assigned to you, before you start working on that project.
  7. Each participant / contributor will be assigned 1 issue (max) at a time to work.
  8. One PR must correspond to one issue. A PR resolving more than one issue will be deemed invalid.
  9. Participants are expected to follow project guidelines and coding style. Structured code is one of our top priority.
  10. Try to explain your approach to solve any issue in the comments. This will increase the chances of you being assigned.
  11. Don't create issues that are already listed.
  12. Please don't pick up an issue already assigned to someone else. Work on the issues after it gets assigned to you.
  13. Make sure you discuss issues before working on the issue.
  14. Pull requests will be merged after being reviewed by a mentor or PA.
  15. It might take a day or two to review your pull request. Please have patience and be nice.
  16. Always create a pull request from a branch other than main.
  17. Participants / contributors have to complete issues before the decided Deadline. If you fail to make a PR within the deadline, then the issue will be assigned to another person in the queue.
  18. While making PRs, don't forget to add a description of your work.
  19. Any PR made by any contributor to resolve any issue without being assigned to it will be deemed invalid.
  20. Include issue number (Fixes:issuenumber) in your commit message while creating a pull request.
  21. Make sure your solution to any issue is better in terms of performance and other parameters in comparison to the previous work.
  22. We all are here to learn. You are allowed to make mistakes. That's how you learn, right!.

🧲Pull Requests Review Criteria

  1. Your work must be original, written by you not copied from other resources.
  2. You must comment on your code where necessary.
  3. For frontend changes, kindly share screenshots and work samples of your work before sending a PR.
  4. Follow the proper style guides for your work.
  5. For any queries or discussions, please feel free to drop a message.
  6. Pull Requests will be reviewed based on code quality, documentation, and adherence to coding standards.
  7. Pull Requests must correspond to any existing issue and the contributor must be assigned to that issue.
  8. One PR must correspond to one issue. A PR resolving more than one issue will be deemed invalid.

📖Resources

  1. Markdown : Markdown is a lightweight markup language like HTML, with plain text formatting syntax.
  1. Git : Git is a distributed version-control system for tracking changes in source code during software development. It is designed for coordinating work among programmers, but it can be used to track changes in any set of files.

🤔Need more help?

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

🎉 🎊 😃 Happy Contributing 😃 🎊 🎉