Skip to content

Latest commit

 

History

History
118 lines (72 loc) · 5.64 KB

CONTRIBUTING.md

File metadata and controls

118 lines (72 loc) · 5.64 KB
Raw

Contributing Guidelines

🎉 First of all, thanks for taking the time to contribute! 🎉

The following is a set of guidelines for contributing to this project. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Code of Conduct 📜

This project and everyone participating in it is governed by a Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to @vinzvinci or in our Discord server.

How can I contribute? 🤔

Reporting Bugs 💣

This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻, and find related reports. 🔎

Since the new GitHub Issue forms we only suggest you to include most information possible. But you can also Perform a cursory search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.

Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.

Suggesting Enhancements 🛠

This section guides you through submitting an enhancement suggestion, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion 📝 and find related suggestions. 🔎

Since the new GitHub Issue forms we only suggest you to include most information possible. But you can also Perform a cursory search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.

Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.

Your First Code Contribution 🟩

Unsure where to begin contributing to this project? You can start by looking through these beginner and help-wanted issues:

  • Beginner issues - issues which should only require a few lines of code, and a test or two.
  • Help wanted issues - issues which should be a bit more involved than beginner issues.

Pull Requests 📣

The process described here has several goals:

  • Maintain the project's quality
  • Fix problems that are important to users
  • Engage the community in working toward the best possible!
  • Enable a sustainable system for maintainers to review contributions

Please follow all instructions in the template

Style Guide for Git Commit Messages 📝

How you can add more value to your contribution logs:

  • Use the present tense. (Example: "Add feature" instead of "Added feature")
  • Use the imperative mood. (Example: "Move item to...", instead of "Moves item to...")
  • Limit the first line (also called the Subject Line) to 50 characters or less.
  • Capitalize the Subject Line.
  • Separate subject from body with a blank line.
  • Do not end the subject line with a period.
  • Wrap the body at 72 characters.
  • Use the body to explain the what, why, vs, and how.
  • Reference issues and pull requests liberally after the first line.
  • Follow conventional commits

🚀 How to Contribute

  • Please create an issue before creating a pull request.

  • Fork the repository and create a branch for any issue that you are working on.

  • Create a pull request which will be promptly reviewed and suggestions would be added to improve it.

  • Add screenshots to help us know what changes you have done.

🤔 How to make a pull request

1. Fork this repository. Click on the symbol at the top right corner.

2. Clone the forked repository.

git clone https://github.com/<your-username>/start-here.git

3. Navigate to the project directory.

cd start-here

4. Create a new branch:

git checkout -b your-branch-name

5. Make the necessary changes.

6. Stage your changes and commit

git add .
git commit -m "<your_commit_message>"

Follow our commit guide from above

7. Push your local commits to the remote repository.

git push origin your-branch-name

8. Create a new pull request from your-branch-name

9. 🎉 Congratulations! You've made your first pull request! Now, you should just wait until the maintainers review your pull request.

WebXDAO 🌐

😕 Not sure where to start? Join our community on Discord
✨ You can also take part in Community Discussion