Welcome to The Documentation Compendium! This guide will assist you in making valuable contributions to this project. Your efforts to improve and enhance our work are highly appreciated.
- Understanding the Codebase: Familiarize yourself with the structure and organization of the project files. For a detailed overview, refer to our Codebase Structure.
- Adhering to Standards: It's crucial that your contributions align with our established practices. Please review the Coding Guidelines to ensure compliance.
-
Fork the Repository:
- Begin by forking the repository to your GitHub account. You can do this at: https://github.com/skywolfmo/bookmarksai/fork.
-
Create a New Branch:
- Checkout a new branch for your work. Name it appropriately based on the nature of your contribution.
- For example:
In case of any issues, you might need to update your local repository:
$ git checkout -b BRANCH_NAME
$ git remote update && git fetch - It's best to use separate branches for different fixes or features.
-
Commit Your Changes:
- When making changes, ensure your git commit messages are clear and descriptive.
- Follow our commit message conventions.
- Commit these changes to your forked repository.
- For example:
$ git commit -am 'Add some feature or fix'
-
Push Your Changes:
- Push the changes to your branch.
- For example:
$ git push origin BRANCH_NAME
- Create a Pull Request:
- Once you've pushed your changes, create a pull request (PR) to the
fooBarbranch of the main repository. - Ensure that your PR details the changes you've made and why they are necessary.
- Our continuous integration system, Travis CI, will automatically check your submission.
- Once you've pushed your changes, create a pull request (PR) to the
By following these steps, your contribution should smoothly integrate with the main project. We look forward to your valuable input!