Thank you for your interest in contributing to the Mock-Project Club Onboarding! We welcome contributions from the community to make this project better. There are several ways you can contribute:
This is the first and mandatory task for all the contributers, to do this check if there's an existing issue labeled with club-member-request in our Issue Tracker and follow the instructions provided there.
All project documentation can be found in the /notes directory. This is where you can make improvements, fix errors, or add new information.
Look for areas in the documentation that require updates or clarifications. This might include correcting typos, updating outdated information, or adding explanations where they are lacking.
Maintain the existing structure and format of the documentation. This helps in keeping a consistent look and feel throughout the project's documentation.
When you've made your documentation changes, create a pull request (PR). Clearly describe the changes you've made and reference any relevant issues if applicable.
The project's source code is located in the /javaProblems directory. You can contribute to code by fixing bugs, adding features, or improving existing functionality.
Before making code changes, look for open issues related to the part of the code you want to work on. If there isn't an existing issue, consider creating one to discuss and track your proposed changes.
Feel free to open an issue if you have found a bug or wish to see a feature implemented.
In case you see any mistake in any doc, do not hesitate to submit a ticket to the Bug Tracker. You are also welcome to pull requests.
Before creating a new issue, search the issue tracker to check if a similar issue already exists. If you find a relevant issue, feel free to comment and provide additional information or insights.
When creating an issue, provide a clear and concise title that describes the problem or feature request. In the issue description:
- Include steps to reproduce a bug.
- Describe the expected behavior.
- Specify the actual behavior you observed.
- Mention any error messages or log outputs.
- If suggesting a new feature, explain its purpose and potential benefits.
- You can also use the templates provided when you click on
New issue.
Assign appropriate labels to your issue to help categorize and prioritize it. Labels may include "bug," "feature," "documentation," and others relevant to your project.
Some projects may have specific issue templates. Please follow the template provided to ensure all necessary information is included.
To contribute code, fork the repository to your GitHub account. Create a new branch for your changes, ensuring it has a descriptive name (e.g., feature/add-new-feature or bugfix/fix-issue-123).
Regularly sync your fork with the main repository to incorporate any changes. You can do this using Git commands or the "Sync" button on GitHub.
For each feature, bug fix, or improvement, create a separate branch. This makes it easier to manage and review your changes.
Adhere to the project's coding standards and style guidelines. If there are specific conventions or formatting rules, make sure your code complies with them.
Each commit message should be concise and describe the purpose of the commit. Use the imperative mood (e.g., "Fix bug" rather than "Fixed bug").
When creating a PR, include a clear and comprehensive description of your changes. Explain why the changes are necessary and how they address the issue or improve the project.
If your PR relates to a specific issue, reference it by including "Fixes #issue-number" or "Closes #issue-number" in the PR description. This automatically links the PR to the issue and helps with issue tracking.
Keep PRs focused on a single, well-defined task or feature. If you have multiple changes to propose, create separate PRs for each.
Maintainers and reviewers may take some time to review your PR. Be patient and responsive to their feedback and requests for changes.
Thank you for contributing to club-onboarding. Your involvement is invaluable to the growth and improvement of our project. Happy coding!