Skip to content
Docs
Terms
How to Contribute

How to Contribute

Contribute to code

Contributing to the codebase is a great way to help improve the project. Here’s how you can get started:

Create a Pull Request

  1. Fork the repository: Click the “Fork” button in the top right corner of the repository page to create your own copy of the repo.
  2. Clone the repository: Clone your forked repository to your local machine using git clone .
  3. Create a new branch: Create a new branch for your changes with a descriptive name, such as feature/add-new-feature or fix/bug-description.
   git checkout -b feature/your-feature-name
  1. Make your changes: Implement your changes or new features. Make sure your code adheres to the project’s coding standards and guidelines.
  2. Commit your changes: Use the Conventional Commits Specification for your commit messages.
  git commit -m "feat: description of your feature"
  1. Push your changes: Push your changes to your forked repository.
  git push origin feature/your-feature-name
  1. Create a Pull Request: Go to the original repository and create a new pull request. Make sure to provide a detailed description of your changes.

Improve documentation

Good documentation is essential for any project. Here’s how you can contribute to the documentation:

  1. Identify areas for improvement: Look for typos, unclear sections, or outdated information in the existing documentation.
  2. Edit the documentation: This website lives in the chapar-rest.github.io repository; the documentation pages are Markdown files in content/docs.
  3. Follow the same process: Use the same GitHub flow and Conventional Commits Specification as you would for code contributions.
  4. Submit a Pull Request: Provide a clear explanation of the documentation improvements you made.

Help others

Participating in the community and helping others is a valuable way to contribute. Here’s how you can get involved:

Answer questions: Visit the Chapar Issues page to find questions and issues raised by other users. Provide helpful answers and solutions.

Share knowledge: Write tutorials, blog posts, or create videos explaining how to use different features of the project.

Report bugs: If you encounter any bugs, report them by creating a new issue on the Chapar Issues page. Provide detailed information to help the maintainers understand and reproduce the issue.

Join the conversation: the #chapar channel on the Gophers Slack is the place to get help and help others with Chapar.

Contribute financially

Help support the team developing Chapar by becoming a financial contributor.

Privacy PolicyFinancial Contributions